integration server b is reference

webMethods, Inc.3930 Pender DriveFairfax, VA 22030USA703.460.2500http://www.webmethods.com

webMethods Integration ServerBuilt-In Services Reference

VERSION 6.1

webMethods Administrator, webMethods Broker, webMethods Dashboard, webMethods Developer, webMethods Glue, webMethods Fabric, webMethods Installer, webMethods Integration Server, webMethods Mainframe, webMethods Manager, webMethods Mobile, webMethods Modeler, webMethods Monitor, webMethods Optimize, webMethods Trading Networks, webMethods Workflow, and the webMethods logo are trademarks of webMethods, Inc. "webMethods" is a registered trademark of webMethods, Inc.

Acrobat, Adobe, and Reader are registered trademarks of Adobe Systems Incorporated. Amdocs and ClarifyCRM are registered trademarks of Amdocs Ltd. Ariba is a registered trademark of Ariba Inc. BEA is a registered trademark, and BEA WebLogic Platform and BEA WebLogic Server are trademarks of BEA Systems, Inc. BMC Software and PATROL are registered trademarks of BMC Software, Inc. BroadVision is a registered trademark of BroadVision, Inc. Chem eStandards and CIDX are trademarks of Chemical Industry Data Exchange. Unicenter is a registered trademark of Computer Associates International, Inc. Kenan and Arbor are registered trademarks of CSG Systems, Incorporated. SNAP-IX is a registered trademark, and Data Connection is a trademark of Data Connection Ltd. DataDirect, DataDirect Connect, and SequeLink are registered trademarks of DataDirect Technologies. D&B and D-U-N-S are registered trademarks of D&B, Inc. Entrust is a registered trademark of Entrust. Hewlett-Packard, HP, HP-UX, and OpenView are trademarks of Hewlett-Packard Company. i2 is a registered trademark of i2 Technologies, Inc. AIX, AS/400, CICS, DB2, IBM, Infoprint, Informix, MQSeries, OS/390, OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, and WebSphere are registered trademarks; and Communications System for Windows NT, IMS, MVS, SQL/DS, Universal Database, and z/OS are trademarks of IBM Corporation. JBoss and JBoss Group are trademarks of Marc Fleury under operation by JBoss Group, LLC. J.D. Edwards and OneWorld are registered trademarks, and WorldSoftware is a trademark of J.D. Edwards. Linux is a registered trademark of Linus Torvalds and others. X Window System is a trademark of Massachusetts Institute of Technology. MetaSolv is a registered trademark of Metasolv Software, Inc. ActiveX, Microsoft, Outlook, Visual Basic, Windows, and Windows NT are registered trademarks; and SQL Server is a trademark of Microsoft Corporation. Teradata is a registered trademark of NCR. Netscape is a registered trademark of Netscape Communications Corporation. New Atlanta and ServletExec are trademarks of New Atlanta Communications, LLC. CORBA is a registered trademark of Object Management Group, Inc. UNIX is a registered trademark of Open Group. Oracle is a registered trademark of Oracle Corporation. PeopleSoft and Vantive are registered trademarks, and PeopleSoft Pure Internet Architecture is a trademark of PeopleSoft, Inc. Infranet and Portal are trademarks of Portal Software, Inc. RosettaNet is a trademark of “RosettaNet,” a non-profit organization. SAP and R/3 are trademarks or registered trademarks of SAP AG. Siebel is a trademark of Siebel Systems, Inc. SPARC and SPARCStation are trademarks of SPARC International, Inc. SSA Global is a trademark and SSA Baan is a registered trademark of SSA Global Technologies, Inc. EJB, Enterprise JavaBeans, Java, Java Naming and Directory Interface, JavaServer Pages, JDBC, JSP, J2EE, Solaris, Sun Microsystems, and SunSoft are trademarks of Sun Microsystems, Inc. SWIFT and SWIFTNet are trademarks of S.W.I.F.T. SCRL. Sybase is a registered trademark of Sybase, Inc. UCCnet is a trademark of UCCnet. eBusinessReady is a trademark of Uniform Code Council, Inc. (UCC) and Drummond Group, Inc. (DGI). Verisign is a registered trademark of Verisign. VERITAS, VERITAS SOFTWARE, and VERITAS Cluster Server are trademarks of VERITAS Software. W3C is a registered trademark of World Wide Web Consortium.

All other marks are the property of their respective owners.

Copyright © 2004 by webMethods, Inc. All rights reserved, including the right of reproduction in whole or in part in any form.

Document ID: IS-BIS-RF-61-20040116

Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Chapter 1. ART Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26pub.art.connection:disableConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27pub.art.connection:enableConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27pub.art.connection:getConnectionStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27pub.art.connection:queryConnectionState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28pub.art.listener:disableListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28pub.art.listener:enableListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29pub.art.listener:queryListenerState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29pub.art.listener:setListenerNodeConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29pub.art.notification:disableListenerNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30pub.art.notification:disablePollingNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30pub.art.notification:enableListenerNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30pub.art.notification:enablePollingNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31pub.art.notification:queryListenerNotificationState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31pub.art.notification:queryPollingNotificationState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31pub.art.notification:setListenerNotificationNodeListener . . . . . . . . . . . . . . . . . . . . . . . . . . . 32pub.art.notification:setPollingNotificationNodeConnection . . . . . . . . . . . . . . . . . . . . . . . . . . 32pub.art.service:setAdapterServiceNodeConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33pub.art.transaction:commitTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33pub.art.transaction:rollbackTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34pub.art.transaction:setTransactionTimeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34pub.art.transaction:startTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Chapter 2. Client Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38pub.client:ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39pub.client:http . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40pub.client:smtp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

webMethods Integration Server Built-In Services Reference Version 6.1 3

C o n t e n t s

pub.client:soapHTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47pub.client:soapRPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49pub.client.ftp:append . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51pub.client.ftp:cd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52pub.client.ftp:cdls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52pub.client.ftp:delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53pub.client.ftp:dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53pub.client.ftp:get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54pub.client.ftp:login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55pub.client.ftp:logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56pub.client.ftp:ls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56pub.client.ftp:mdelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57pub.client.ftp:mget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57pub.client.ftp:mput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58pub.client.ftp:put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58pub.client.ftp:quote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59pub.client.ftp:rename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59pub.client.ftp:sessioninfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 3. Cluster Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62pub.cluster:disableServiceRedir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62pub.cluster:disableSessionRedir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62pub.cluster:getClusterHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Chapter 4. Date Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66pub.date:currentDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69pub.date:dateBuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70pub.date:dateTimeBuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71pub.date:dateTimeFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72pub.date:formatDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72pub.date:getCurrentDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73pub.date:getCurrentDateString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

4 webMethods Integration Server Built-In Services Reference Version 6.1

Chapter 5. Db Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76pub.db:call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77pub.db:clearTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79pub.db:close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80pub.db:closeAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81pub.db:commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81pub.db:connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82pub.db:delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84pub.db:execSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85pub.db:getProcInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89pub.db:getProcs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90pub.db:getTableInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91pub.db:getTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93pub.db:insert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94pub.db:query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96pub.db:rollback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97pub.db:startTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98pub.db:update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Chapter 6. Document Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102pub.document:documentListToDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102pub.document:documentToDocumentList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103pub.document:documentToXMLValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104pub.document:XMLValuesToDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Chapter 7. Event Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108pub.event:addSubscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109pub.event:alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112pub.event:alarmInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113pub.event:audit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113pub.event:auditInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114pub.event:callStackItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114pub.event:deleteSubscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115pub.event:exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116


C o n t e n t s

pub.event:exceptionInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117pub.event:gdEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117pub.event:gdEndInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118pub.event:gdStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118pub.event:gdStartInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119pub.event:getEventTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119pub.event:getSubscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120pub.event:modifySubscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121pub.event:portStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124pub.event:portStatusInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125pub.event:reloadEventManagerSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125pub.event:replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126pub.event:replicationInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126pub.event:saveEventManagerSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127pub.event:sessionEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127pub.event:sessionEndInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128pub.event:sessionExpire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128pub.event:sessionExpireInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128pub.event:sessionStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129pub.event:sessionStartInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129pub.event:stat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130pub.event:statInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131pub.event:txEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132pub.event:txEndInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132pub.event:txStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133pub.event:txStartInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133pub.event.audit:logToFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133pub.event.exception:logToFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Chapter 8. File Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136pub.file:getFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Chapter 9. Flow Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140pub.flow:clearPipeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141pub.flow:debugLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141


pub.flow:getLastError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141pub.flow:getRetryCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142pub.flow:getSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143pub.flow:getTransportInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143pub.flow:restorePipeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144pub.flow:restorePipelineFromFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145pub.flow:savePipeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145pub.flow:savePipelineToFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146pub.flow:setResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146pub.flow:throwExceptionForRetry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147pub.flow:tracePipeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148pub.flow:transportInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Chapter 10. IO Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154pub.io:bytesToStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154pub.io:streamToBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Chapter 11. LDAP Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156pub.ldap:bind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156pub.ldap:connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157pub.ldap:delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158pub.ldap:disconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158pub.ldap:getAttributeDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158pub.ldap:getClassDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159pub.ldap:list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160pub.ldap:lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162pub.ldap:search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163pub.ldap:update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Chapter 12. List Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168pub.list:appendToDocumentList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168pub.list:appendToRecordList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169pub.list:appendToStringList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170pub.list:copyListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170


C o n t e n t s

pub.list:getListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171pub.list:getRecordListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171pub.list:getStringListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171pub.list:setListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172pub.list:setRecordListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172pub.list:setStringListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172pub.list:sizeOfList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173pub.list:stringListToDocumentList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173pub.list:stringListToRecordList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

Chapter 13. Math Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178pub.math:addFloatList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179pub.math:addFloats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180pub.math:addIntList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180pub.math:addInts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181pub.math:addObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181pub.math:divideFloats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182pub.math:divideInts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183pub.math:divideObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183pub.math:multiplyFloatList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184pub.math:multiplyFloats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185pub.math:multiplyIntList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186pub.math:multiplyInts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186pub.math:multiplyObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187pub.math:randomDouble . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187pub.math:subtractFloats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188pub.math:subtractInts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188pub.math:subtractObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Chapter 14. MIME Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192pub.mime:addBodyPart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192pub.mime:addMimeHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196pub.mime:createMimeData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198pub.mime:getBodyPartContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200pub.mime:getBodyPartHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202


pub.mime:getContentType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203pub.mime:getEnvelopeStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204pub.mime:getMimeHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205pub.mime:getNumParts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206pub.mime:getPrimaryContentType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207pub.mime:getSubContentType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208pub.mime:mergeHeaderAndBody . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

Chapter 15. Packages Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212pub.packages:activatePackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212pub.packages:disablePackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213pub.packages:enablePackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214pub.packages:installPackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214pub.packages:recoverPackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215pub.packages:reloadPackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

Chapter 16. PKI Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220pub.pki.pkcs7:sign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220pub.pki.pkcs7:verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221pub.pki.smime.createSignedAndEncryptedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222pub.pki.smime.createSignedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223pub.pki.smime:processEncryptedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224pub.pki.smime:processSignedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Chapter 17. PRT Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230pub.prt:CorrelationService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231pub.prt:ProcessData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232pub.prt.admin:changeProcessStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233pub.prt.admin:deleteProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234pub.prt.admin:scanPackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234pub.prt.assign:expToProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235pub.prt.assign:expToVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236pub.prt.assign:literalObjectToProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236pub.prt.assign:literalObjectToVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237


C o n t e n t s

pub.prt.assign:literalStringToProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237pub.prt.assign:literalStringToVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237pub.prt.assign:literalToPartner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238pub.prt.assign:partnerToPartner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239pub.prt.assign:partnerToVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239pub.prt.assign:propertyToProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240pub.prt.assign:propertyToVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240pub.prt.assign:setPartnerAuthentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241pub.prt.assign:variableToPartner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241pub.prt.assign:variableToProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242pub.prt.assign:variableToVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242pub.prt.correlate:deleteCorrelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243pub.prt.correlate:establishCorrelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243pub.prt.correlate:lookupCorrelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244pub.prt.globalData:lockGlobalData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245pub.prt.log:logActivityMessages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246pub.prt.tn:deleteByCID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246pub.prt.tn:getPIDforCID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247pub.prt.tn:getRoleInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248pub.prt.tn:handleBizDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248pub.prt.tn:mapCIDtoPID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249pub.prt.tn:RoleInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

Chapter 18. Publish Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254pub.publish:deliver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254pub.publish:deliverAndWait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256pub.publish:documentResolverSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258pub.publish:envelope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259pub.publish:getRedeliveryCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263pub.publish:publish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264pub.publish:publishAndWait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266pub.publish:reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268pub.publish:waitForReply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270pub.publish.notification:error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271


Chapter 19. Record Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274pub.record:length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274pub.record:recordListToRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274pub.record:recordToRecordList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275pub.record:recordToXMLValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276pub.record:XMLValuesToRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

Chapter 20. Remote Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278pub.remote:invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278pub.remote.gd:end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280pub.remote.gd:getStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280pub.remote.gd:invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281pub.remote.gd:restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281pub.remote.gd:retrieve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282pub.remote.gd:send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282pub.remote.gd:start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283pub.remote.gd:submit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

Chapter 21. Replicator Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286pub.replicator:addReleaseRegistryEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286pub.replicator:deleteReleaseRegistryEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287pub.replicator:distributeViaFTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288pub.replicator:distributeViaSvcPull . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289pub.replicator:distributeViaSvcPush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289pub.replicator:generateReplicationEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289pub.replicator:getLocalReleasedList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290pub.replicator:getRemoteReleasedList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290pub.replicator:notifyPackageRelease . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291pub.replicator:packageCreation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

Chapter 22. Report Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296pub.report:runFileTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296pub.report:runFileTemplateOnPipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297pub.report:runStringTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297


C o n t e n t s

pub.report:runStringTemplateOnPipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298pub.report:runTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298pub.report:runTemplateOnPipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Chapter 23. Scheduler Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302pub.scheduler:addComplexTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302pub.scheduler:addOneTimeTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304pub.scheduler:addRepeatingTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305pub.scheduler:cancelTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306pub.scheduler:getTaskIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306pub.scheduler:getTaskInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307pub.scheduler:resumeTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309pub.scheduler:suspendTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309pub.scheduler:updateComplexTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309pub.scheduler:updateOneTimeTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311pub.scheduler:updateRepeatingTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

Chapter 24. Schema Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316pub.schema:createXSD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316pub.schema:validate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318pub.schema:validatePipeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319pub.schema.w3c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320pub.schema.w3c:xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321pub.schema.w3c:xsi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

Chapter 25. Security Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324pub.security:clearKeyAndChain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325pub.security:setKeyAndChain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326pub.security:getNumConnections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326pub.security.pkcs7:sign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327pub.security.pkcs7:verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328pub.security.reverseInvoke:deleteAllConnections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329pub.security.reverseInvoke:deleteConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329pub.security.reverseInvoke:disableListeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329


pub.security.reverseInvoke:getNumConnections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330pub.security.reverseInvoke:getServerType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330pub.security.reverseInvoke:keepAliveConnections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331pub.security.reverseInvoke:listProxyListeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331pub.security.reverseInvoke:listRegisteredConnections . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333pub.security.reverseInvoke:listRegistrationListeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333pub.security.reverseInvoke:registerReverseConnections . . . . . . . . . . . . . . . . . . . . . . . . . . 335pub.security.util:createMessageDigest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335pub.security.util:getCertificateInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336pub.security.util:loadPKCS7CertChain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

Chapter 26. SMIME Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340pub.smime:createCertsOnlyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340pub.smime:createEncryptedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341pub.smime:createSignedAndEncryptedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342pub.smime:createSignedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343pub.smime:processCertsOnlyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344pub.smime:processEncryptedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345pub.smime:processSignedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

Chapter 27. SOAP Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350pub.soap.processor:list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351pub.soap.processor:processMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352pub.soap.processor:processRPCMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353pub.soap.processor:registerProcessor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354pub.soap.processor:unregisterProcessor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355pub.soap.schema:encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356pub.soap.schema:envelope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356pub.soap.utils:addBodyEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356pub.soap.utils:addHeaderEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357pub.soap.utils:addTrailer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359pub.soap.utils:createSoapData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360pub.soap.utils:exitUnableToUnderstand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360pub.soap.utils:getActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361pub.soap.utils:getBody . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361


C o n t e n t s

pub.soap.utils:getBodyEntries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362pub.soap.utils:getDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363pub.soap.utils:getHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363pub.soap.utils:getHeaderEntries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364pub.soap.utils:getMustUnderstand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365pub.soap.utils:getQName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366pub.soap.utils:getTrailers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367pub.soap.utils:QName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367pub.soap.utils:removeBodyEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368pub.soap.utils:removeHeaderEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368pub.soap.utils:removeTrailer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369pub.soap.utils:requestResponseSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370pub.soap.utils:soapDataToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371pub.soap.utils:streamToSoapData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371pub.soap.utils:stringToSoapData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372pub.soap.utils:validateSoapData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373

Chapter 28. Storage Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376pub.storage:add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376pub.storage:closeStore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377pub.storage:deleteStore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377pub.storage:get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378pub.storage:keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379pub.storage:lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379pub.storage:put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380pub.storage:registerStore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380pub.storage:remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381pub.storage:unlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

Chapter 29. String Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384pub.string:base64Decode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385pub.string:base64Encode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385pub.string:bytesToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385pub.string:concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386pub.string:HTMLDecode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386


pub.string:HTMLEncode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387pub.string:indexOf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387pub.string:length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388pub.string:lookupDictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388pub.string:lookupTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388pub.string:makeString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389pub.string:messageFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390pub.string:numericFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390pub.string:padLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391pub.string:padRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392pub.string:replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393pub.string:stringToBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393pub.string:substring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394pub.string:toLower . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394pub.string:toUpper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394pub.string:tokenize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395pub.string:trim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395pub.string:URLDecode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396pub.string:URLEncode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

Chapter 30. Sync Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398pub.sync:notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398pub.sync:wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

Chapter 31. Synchronization Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402pub.synchronization.latch:closeLatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402pub.synchronization.latch:isLatchClosed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403pub.synchronization.latch:openLatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404pub.synchronization.xref:createXReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404pub.synchronization.xref:deleteByObjectId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405pub.synchronization.xref:deleteXReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406pub.synchronization.xref:getCanonicalKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406pub.synchronization.xref:getNativeId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407pub.synchronization.xref:insertXReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408


C o n t e n t s

Chapter 32. Table Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410pub.table:recordListToTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410pub.table:stringTableToTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410pub.table:tableToRecordList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411pub.table:tableToStringTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

Chapter 33. UDDI Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414pub.uddi.client.doc:accessPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422pub.uddi.client.doc:address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423pub.uddi.client.doc:addressLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423pub.uddi.client.doc:assertionStatusItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424pub.uddi.client.doc:assertionStatusReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425pub.uddi.client.doc:authToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425pub.uddi.client.doc:bindingDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426pub.uddi.client.doc:bindingKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426pub.uddi.client.doc:bindingTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427pub.uddi.client.doc:bindingTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427pub.uddi.client.doc:businessDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427pub.uddi.client.doc:businessDetailExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428pub.uddi.client.doc:businessEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428pub.uddi.client.doc:businessEntityExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429pub.uddi.client.doc:businessInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429pub.uddi.client.doc:businessInfos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430pub.uddi.client.doc:businessKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430pub.uddi.client.doc:businessList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430pub.uddi.client.doc:businessService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431pub.uddi.client.doc:businessServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431pub.uddi.client.doc:categoryBag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431pub.uddi.client.doc:contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432pub.uddi.client.doc:contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432pub.uddi.client.doc:discoveryURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433pub.uddi.client.doc:discoveryURLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433pub.uddi.client.doc:dispositionReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433pub.uddi.client.doc:docType_categoryBag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434


pub.uddi.client.doc:docType_description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434pub.uddi.client.doc:docType_keyedReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434pub.uddi.client.doc:docType_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435pub.uddi.client.doc:email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435pub.uddi.client.doc:errInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435pub.uddi.client.doc:findQualifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435pub.uddi.client.doc:findQualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436pub.uddi.client.doc:fromKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436pub.uddi.client.doc:hostingRedirector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436pub.uddi.client.doc:identifierBag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436pub.uddi.client.doc:instanceDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437pub.uddi.client.doc:instanceParms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437pub.uddi.client.doc:keyedReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437pub.uddi.client.doc:keysOwned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438pub.uddi.client.doc:overviewDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438pub.uddi.client.doc:phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438pub.uddi.client.doc:publisherAssertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439pub.uddi.client.doc:publisherAssertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439pub.uddi.client.doc:registeredInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439pub.uddi.client.doc:relatedBusinessInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440pub.uddi.client.doc:relatedBusinessInfos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440pub.uddi.client.doc:relatedBusinessesList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440pub.uddi.client.doc:result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441pub.uddi.client.doc:schema_uddiv2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441pub.uddi.client.doc:serviceDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441pub.uddi.client.doc:serviceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442pub.uddi.client.doc:serviceInfos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442pub.uddi.client.doc:serviceKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442pub.uddi.client.doc:serviceList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442pub.uddi.client.doc:sharedRelationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443pub.uddi.client.doc:SOAPFault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443pub.uddi.client.doc:tModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443pub.uddi.client.doc:tModelBag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444pub.uddi.client.doc:tModelDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444pub.uddi.client.doc:tModelInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445


C o n t e n t s

pub.uddi.client.doc:tModelInfos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445pub.uddi.client.doc:tModelInstanceDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445pub.uddi.client.doc:tModelInstanceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445pub.uddi.client.doc:tModelKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446pub.uddi.client.doc:tModelList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446pub.uddi.client.doc:toKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447pub.uddi.client.doc:uploadRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447pub.uddi.client.inquiry:find_binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447pub.uddi.client.inquiry:find_business . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448pub.uddi.client.inquiry:find_businessByCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449pub.uddi.client.inquiry:find_businessByDiscURLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450pub.uddi.client.inquiry:find_businessByIdentity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450pub.uddi.client.inquiry:find_businessByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451 pub.uddi.client.inquiry:find_businessBytModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452pub.uddi.client.inquiry:find_relatedBusinesses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453pub.uddi.client.inquiry:find_service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454pub.uddi.client.inquiry:find_serviceByBusKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455pub.uddi.client.inquiry:find_serviceByCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456pub.uddi.client.inquiry:find_serviceByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457pub.uddi.client.inquiry:find_serviceBytModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458pub.uddi.client.inquiry:find_tModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459pub.uddi.client.inquiry:find_tModelByCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460pub.uddi.client.inquiry:find_tModelByIdentity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460pub.uddi.client.inquiry:find_tModelByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461 pub.uddi.client.inquiry:get_bindingDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462pub.uddi.client.inquiry:get_businessDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463 pub.uddi.client.inquiry:get_businessDetailExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464 pub.uddi.client.inquiry:get_serviceDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464 pub.uddi.client.inquiry:get_tModelDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465pub.uddi.client.publish:add_publisherAssertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466pub.uddi.client.publish:delete_binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467pub.uddi.client.publish:delete_business . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467pub.uddi.client.publish:delete_publisherAssertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468pub.uddi.client.publish:delete_service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469pub.uddi.client.publish:delete_tModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470


pub.uddi.client.publish:discard_authToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470pub.uddi.client.publish:get_assertionstatusReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471pub.uddi.client.publish:get_authToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472pub.uddi.client.publish:get_publisherAssertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473pub.uddi.client.publish:get_registeredInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474pub.uddi.client.publish:save_binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475pub.uddi.client.publish:save_business . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475pub.uddi.client.publish:save_service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476pub.uddi.client.publish:save_tModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477pub.uddi.client.publish:set_publisherAssertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

Chapter 34. UniversalName Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480pub.universalName:find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480pub.universalName:list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

Chapter 35. Web Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484pub.web:createRegions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484pub.web:documentToRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486pub.web:freeDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494pub.web:getDocumentType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494pub.web:getNextNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495pub.web:getNodeIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496pub.web:loadDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498pub.web:makeArrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503pub.web:queryDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503pub.web:recordToDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505pub.web:stringToDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510

Chapter 36. XML Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512pub.xml:documentToXMLString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512pub.xml:freeXMLNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518pub.xml:getNextXMLNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519pub.xml:getXMLNodeIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519pub.xml:getXMLNodeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521


C o n t e n t s

pub.xml:loadXMLNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522pub.xml:queryXMLNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527pub.xml:xmlNodeToDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529pub.xml:xmlStringToXMLNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537


About This Guide

About This Guide

The webMethods Built-In Services Reference describes the built-in services provided with a standard installation of the webMethods Integration Server. Services are also installed with webMethods add-on packages, such as adapters and monitoring tools. You will find documentation for those services in the user guide provided with the add-on product.

The descriptions in this book are divided into the following folders. These folders reside in the WmPublic package, unless specified otherwise.

Folder Page Contains services you use to…

art 25 (WmART package) Manage adapter components, including connections, adapter services, listeners, and notifications.

client 37 Formulate and submit requests to HTTP, FTP, and email servers.

cluster 61 Enable and/or disable load balancing for specific services and sessions in a cluster.

date 65 Generate and format date values.

db 75 (WmDB package) Access JDBC-enabled databases. The webMethods JDBC adapter also provides services that perform operations against JDBC-enabled databases. See the JDBC Adapter User Guide for information.

document 101 Perform operations on documents in the pipeline.

event 107 Build audit and event handler services.

file 135 Perform operations on the local file system.

flow 139 Perform debugging and utility-type tasks in a flow service.

io 153 Convert data between byte[ ] and InputStream representations.

ldap 155 Access and update information on an LDAP directory server.

list 167 Retrieve, replace, or add elements in an Object List, Document List, or String List; convert String Lists to Document Lists.

math 177 Add, subtract, multiply, or divide string-based numeric values.

mime 191 Create MIME messages and extract information from MIME messages.

packages 211 Install, load, and/or alter the status of a package on the Integration Server.

pki 219 (WmPKI package) Create and verify PKCS#7 signatures with PKI profiles and create and process S/MIME messages using PKI profiles.

prt 229 (WmPRT package) Interact with the process run-time facility.

publish 253 Publish and deliver documents to the integration platform’s messaging facility.


A b o u t T h i s G u i d e

record 273 Deprecated. Perform operations on documents in the pipeline. Use services in the document folder instead.

remote 277 Invoke services on remote webMethods Integration Servers.

replicator 285 Replicate packages across webMethods Integration Servers.

report 295 Apply an output template to the values in the pipeline.

scheduler 301 Schedule services to execute at the times you specify.

schema 315 Validate objects or values in the pipeline.

security 323 Control which client certificates are sent to other services and to digitally sign data and process digital signatures.

smime 339 Create digitally signed and/or encrypted MIME messages. Process signed and encrypted MIME messages.

soap 349 Send, receive, and retrieve data from SOAP messages. Register custom SOAP processors.

storage 375 Create, close, delete, and register repository data stores. Insert and retrieve information from data stores.

string 383 Perform string manipulation and substitution operations.

sync 397 Coordinate the execution of services.

synchronization 401 Perform latching and cross-referencing operations in a publish-and-subscribe integration.

table 409 Deprecated. Convert instances of com.wm.util.Table to other data types.

universalName 479 List the contents of the Universal Registry and look up services by their universal names.

UDDI 413 (WmUDDI package) Query about Web service information and publish an existing Integration Server service as a Web service to a UDDI server.

web 483 Deprecated. Perform operations on XML and HTML documents. Use services in the xml folder instead.

xml 511 Perform operations on XML documents.

Folder Page Contains services you use to…


Built-in services generally have the following default access permissions:

These default access permissions cannot be changed (that is, another ACL cannot be selected).

Document Convent ions

For this type of permission... Built-in services are assigned to this ACL...

List Developers. Members of the Developers ACL can see, in webMethods Integration Server or Developer, that a service exists.

Read WmPrivate. The WmPrivate ACL is a virtual ACL designated by webMethods to protect the proprietary code in the built-in services. As this ACL has no members, no user can edit a service or view its source.

Write WmPrivate.

Execute Internal. Members of the Internal ACL can execute a service.

Convention Description

Bold Identifies elements on a screen.

Italic Identifies variable information that you must supply or change based on your specific situation or environment. Identifies terms the first time they are defined in text. Also identifies service input and output variables.

Narrow font Identifies storage locations for services on the webMethods Integration Server using the convention folder.subfolder:service.

Typewriter font

Identifies characters and values that you must type exactly or messages that the system displays on the console.

UPPERCASE Identifies keyboard keys. Keys that you must press simultaneously are joined with the “+” symbol.

\ Directory paths use the “\” directory delimiter unless the subject is UNIX-specific.

[ ] Optional keywords or values are enclosed in [ ]. Do not type the [ ] symbols in your own code.


A b o u t T h i s G u i d e

Addit ional InformationThe webMethods Advantage Web site at http://advantage.webmethods.com provides you with important sources of information about the webMethods Integration Platform:

Troubleshooting Information. webMethods provides troubleshooting information for many webMethods components in the webMethods Knowledge Base.

Documentation Feedback. To provide documentation feedback to webMethods, go to the Documentation Feedback Form on the webMethods Bookshelf.

Additional Documentation. All webMethods documentation is available on the webMethods Bookshelf.


http://advantage.webmethods.com

http://advantage.webmethods.com/troubleshooting

http://advantage.webmethods.com/docfeedback

http://advantage.webmethods.com/docfeedback

http://advantage.webmethods.com/Bookshelf

http://advantage.webmethods.com/Bookshelf

C H A P T E R1
ART Folder
You use the elements in the art folder to manage adapter components; specifically, these elements enable you to manage connections, adapter services, listeners, and notifications. This folder also provides elements to manage any built-in transaction management services supported by your webMethods 6.x adapter. See the documentation provided with your adapter to determine whether your adapter supports the transaction management services.


C H A P T E R 1 A R T F o l d e r

Summary of Elements in this FolderThe following elements are available in this folder:

Element Package and Description

pub.art.connection:disableConnection WmART. Disables a connection.

pub.art.connection:enableConnection WmART. Enables an existing connection.

pub.art.connection:getConnectionStatistics WmART. Returns current usage statistics for a connection.

pub.art.connection:queryConnectionState WmART. Returns the current connection state (enabled/disabled) and error status for a connection.

pub.art.listener:disableListener WmART. Disables a listener.

pub.art.listener:enableListener WmART. Enables an existing listener.

pub.art.listener:queryListenerState WmART. Returns the current state (enabled/disabled) for the listener.

pub.art.listener:setListenerNodeConnection WmART. Changes the connection used by a given listener.

pub.art.notification:disableListenerNotification WmART. Disables a listener notification.

pub.art.notification:disablePollingNotification WmART. Disables a polling notification.

pub.art.notification:enableListenerNotification WmART. Enables an existing listener notification.

pub.art.notification:enablePollingNotification WmART. Enables an existing polling notification.

pub.art.notification:queryListenerNotificationState WmART. Returns the current state (enabled/disabled) for the listener notification.

pub.art.notification:queryPollingNotificationState WmART. Returns the current state (enabled/disabled) for the polling notification.

pub.art.notification:setListenerNotificationNodeListener WmART. Changes the listener used by a given listener notification.

pub.art.notification:setPollingNotificationNodeConnection WmART. Changes the connection used by a given polling notification.

pub.art.service:setAdapterServiceNodeConnection WmART. Changes the connection used by a given adapter service.

pub.art.transaction:commitTransaction WmART. Commits an explicit transaction.

pub.art.transaction:rollbackTransaction WmART. Rolls back an explicit transaction.


pub.art.connection:disableConnection

pub.art .connect ion:disableConnect ionWmART. Disables a connection.

Input Parameters

See Also

pub.art.connection:enableConnection

pub.art .connect ion:enableConnect ionWmART. Enables an existing connection.

Input Parameters

See Also


pub.art .connect ion:getConnect ionStat ist icsWmART. Returns current usage statistics for a connection.

Input Parameters

Output Parameters

pub.art.transaction:setTransactionTimeout WmART. Manually sets a transaction timeout interval for implicit and explicit transactions.

pub.art.transaction:startTransaction WmART. Starts an explicit transaction.


connectionAlias String Name of the connection you want to disable.

connectionAlias String Name of the connection you want to enable.

aliasName String Name of the connection for which you want usage statistics returned.

TotalConnections Integer Current number of connection instances.

BusyConnections Integer Number of connections currently in use by services, notifications, and listeners.



See Also

pub.art.connection:queryConnectionState

pub.art .connect ion:queryConnect ionStateWmART. Returns the current connection state (enabled/disabled) and error status for a connection.

Input Parameters

Output Parameters

See Also

pub.art.connection:getConnectionStatistics



pub.art . l istener:disableListenerWmART. Disables a listener.

Input Parameters

See Also

pub.art.listener:enableListener

FreeConnections Integer Total number of connections created and available for use.

TotalHits Integer Number of times this node successfully provided connections since the last reset.

TotalMisses Integer Number of times this node unsuccessfully provided connections since the last reset (when the request timed out).

connectionAlias String Name of the connection for which you want the connection state and error status returned.

connectionState String Current connection state (enabled/disabled).

hasError Boolean Flag indicating if any error was detected on connection.

listenerName String Name of the listener you want to disable.

forceDisable Boolean Optional. Flag to disable the listener regardless of whether it is still waiting for data from a backend resource.



pub.art . l istener:enableListenerWmART. Enables an existing listener.

Input Parameters

Usage Notes

If you do not enable the connection resource associated with the listener, this service will return without performing any action, and the listener will remain disabled. Therefore, you should invoke pub.art.listener:queryListenerState before calling this service to confirm that the listener has been enabled.

See Also

pub.art.listener:queryListenerState

pub.art.listener:disableListener

pub.art . l istener:queryListenerStateWmART. Returns the current state (enabled/disabled) for the listener.

Input Parameters

Output Parameters

See Also



pub.art . l istener:setListenerNodeConnect ionWmART. Changes the connection used by a given listener.

Input Parameters

listenerName String Name of the listener you want to enable.

listenerName String Name of the listener for which you want the current state (enabled/disabled) returned.

listenerState String Current state (enabled/disabled) of the listener.

listenerName String Name of the listener for which you want to change the connection.

connectionAlias String Name of the new connection to use with the listener.



Usage Notes

You must disable the listener before calling this service.

See Also


pub.art .not i f icat ion:disableListenerNoti f icat ionWmART. Disables a listener notification.

Input Parameters

See Also

pub.art.notification:enableListenerNotification

pub.art .not i f icat ion:disablePol l ingNoti f icat ionWmART. Disables a polling notification.

Input Parameters

See Also

pub.art.notification:enablePollingNotification

pub.art .not i f icat ion:enableListenerNoti f icat ionWmART. Enables an existing listener notification.

Input Parameters

See Also

pub.art.notification:disableListenerNotification

notificationName String Name of the listener notification you want to disable.

notificationName String Name of the polling notification you want to disable.

notificationName String The name of the listener notification you want to enable.



pub.art .not i f icat ion:enablePol l ingNoti f icat ionWmART. Enables an existing polling notification.

Input Parameters

Usage Notes

You must schedule the polling notification before you can run this service. See your adapter user documentation for instructions.

See Also

pub.art.notification:disablePollingNotification

pub.art .not i f icat ion:queryListenerNoti f icat ionStateWmART. Returns the current state (enabled/disabled) for the listener notification.

Input Parameters

Output Parameters

See Also

pub.art.notification:enableListenerNotification


pub.art .not i f icat ion:queryPol l ingNoti f icat ionStateWmART. Returns the current state (enabled/disabled) for the polling notification.

Input Parameters

notificationName String Name of the polling notification.

notificationName String The name of the listener notification for which you want the current state (enabled/disabled) returned.

notificationState String The current state (enabled/disabled) for the listener notification.

notificationName String The name of the polling notification for which you want the current state (enabled/disabled) and schedule settings returned.



Output Parameters

See Also



pub.art .not i f icat ion:setListenerNoti f icat ionNodeListenerWmART. Changes the listener used by a given listener notification.

Input Parameters

Usage Notes

You must disable the listener notification before calling this service.

You use this service for both synchronous and asynchronous listener notifications.

See Also


pub.art .not i f icat ion:setPol l ingNoti f icat ionNodeConnect ionWmART. Changes the connection used by a given polling notification.

Input Parameters

notificationState String The current state (enabled/disabled) for the polling notification.

scheduleSettings IData Object that contains the notification’s schedule settings as follows:

Key Description

notificationInterval Integer Polling frequency of the notification.

notificationOverlap Boolean Flags whether the notification can overlap.

notificationImmediate Boolean Flags whether the notification can fire immediately.

notificationName String Name of the listener notification for which you want to change the listener.

listenerNode String Name of the new listener to use with the listener notification.

notificationName String Name of the polling notification for which you want to change the connection.

connectionAlias String Name of the new connection to use with the polling notification.


pub.art.service:setAdapterServiceNodeConnection

Usage Notes

You must disable the polling notification before calling this service.

See Also


pub.art .service:setAdapterServiceNodeConnect ionWmART. Changes the connection used by a given adapter service.

Input Parameters

Usage Notes

You must enable the new connection prior to calling this service.

See Also


pub.art . t ransact ion:commitTransact ionWmART. Commits an explicit transaction.

Input Parameters

Usage Notes

This service is available only if your adapter supports built-in transaction management services, which you can confirm by checking the user guide for the adapter.

This service must be used in conjunction with the pub.art.transaction:startTransaction service. If the transactionName parameter was not provided in a prior call to pub.art.transaction:startTransaction, a runtime error will be returned.

serviceName String Name of an existing adapter service.

connectionAlias String Name of the new connection to use with the adapter service.

commitTransactionInput Document A document that contains the variable transactionName, described below.

transactionName String Associates a name with an explicit transaction. The transactionName must have been previously used in a call to pub.art.transaction:startTransaction.

This value can be mapped from the output of the corresponding pub.art.transaction:startTransaction.



See Also

pub.art.transaction:startTransaction

pub.art.transaction:rollbackTransaction

pub.art . t ransact ion:rol lbackTransact ionWmART. Rolls back an explicit transaction.

Input Parameters

Usage Notes


This service must be used in conjunction with a pub.art.transaction:startTransaction service. If the given transactionName parameter was not provided in a prior call to pub.art.transaction:startTransaction, a runtime error will be returned.

See Also


pub.art.transaction:commitTransaction

pub.art . t ransact ion:setTransact ionTimeoutWmART. Manually sets a transaction timeout interval for implicit and explicit transactions.

Input Parameters

Usage Notes


When you use this service, you are overriding the Integration Server’s transaction timeout interval.

rollbackTransactionInput Document Contains the variable transactionName, described below.

transactionName String Associates a name with an explicit transaction. The transactionName must have been previously used in a call to pub.art.transaction:startTransaction.

This value can be mapped from the output of the corresponding pub.art.transaction:startTransaction.

timeoutSeconds java.lang.Integer The number of seconds that the implicit or explicit transaction stays open before the transaction manager marks it for rollback.



You must call this service within a flow before the start of any implicit or explicit transactions. Implicit transactions start when you call an adapter service in a flow. Explicit transactions start when you call the pub.art.transaction:startTransaction service.

If the execution of a transaction takes longer than the transaction timeout interval, all transacted operations are rolled back.

This service only overrides the transaction timeout interval for the flow service in which you call it.

See Also


pub.art . t ransact ion:startTransact ionWmART. Starts an explicit transaction.

Input Parameters

Output Parameters

Usage Notes


This service is intended for use with the pub.art.transaction:commitTransaction or pub.art.transaction:rollbackTransaction service. The transactionName value returned by a call to this service should be provided to pub.art.transaction:commitTransaction (to commit the transaction) or pub.art.transaction:rollbackTransaction (to rollback the transaction).

See Also

pub.art.transaction:commitTransaction

pub.art.transaction:rollbackTransaction

startTransactionInput Document Contains the variable transactionName, described below.

transactionName String Optional. Associates name with an explicit transaction. If you leave this parameter blank, the Integration Server will generate a name for you.

startTransactionOutput Document Contains the variable transactionName, described below.

transactionName String The name associated with the explicit transaction.


C H A P T E R2
Client Folder
You use the elements in the client folder to formulate and submit requests to HTTP, FTP, and email servers.


C H A P T E R 2 C l i e n t F o l d e r

Summary of Elements in this Folder The following elements are available in this folder:


pub.client:ftp WmPublic. Performs a series of FTP actions.

pub.client:http WmPublic. Issues an HTTP request that you specify and returns the HTTP response.

pub.client:smtp WmPublic. Sends a MIME-type email message.

pub.client:soapHTTP WmPublic. Submits a SOAP message to a server via HTTP or HTTPS.

pub.client:soapRPC WmPublic. Submits a SOAP remote procedure call via HTTP or HTTPS.

pub.client.ftp:append WmPublic. Appends data to a remote file.

pub.client.ftp:cd WmPublic. Changes the working directory on the FTP server. (This service corresponds to the standard FTP command cd dirpath.)

pub.client.ftp:cdls WmPublic. Changes the working directory on the FTP server and retrieves a list of file names. (This service corresponds to the standard FTP commands cd dirpath and ls namePattern.)

pub.client.ftp:delete WmPublic. Deletes a file in the current working directory on an FTP server. (This service corresponds to the standard FTP command delete somefile.)

pub.client.ftp:dir WmPublic. Retrieves the file list during an FTP session. (This service corresponds to the standard FTP command dir namepattern.)

pub.client.ftp:get WmPublic. Retrieves a file from a remote FTP server. (This service corresponds to the standard FTP command get.)

pub.client.ftp:login WmPublic. Connects to a remote FTP server and logs in with a specified user name and password.

pub.client.ftp:logout WmPublic. Logs off of the FTP server and ends the current FTP session.

pub.client.ftp:ls WmPublic. Retrieves the file list during an FTP session. (This service corresponds to the standard FTP command ls namepattern.)

pub.client.ftp:mdelete WmPublic. Deletes multiple files in the current working directory on an FTP server. (This service corresponds to the standard FTP command mdelete pattern.)

pub.client.ftp:mget WmPublic. Transfers multiple files from the remote FTP server. (This service corresponds to the standard FTP command mget.)

pub.client.ftp:mput WmPublic. Transfers multiple files to a remote FTP server. (This service corresponds to the standard FTP command mput.)

pub.client.ftp:put WmPublic. Transfers a file to a remote FTP server. (This service corresponds to the standard FTP command put.)


pub.client:ftp

pub.cl ient: f tpWmPublic. Performs a series of FTP actions.

This service executes the following sequence:

1 Logs on to an FTP server.

2 Changes to a specified working directory.

3 Performs one of the following FTP commands: ls, put, or get.

4 Logs off the FTP server.

Input Parameters

pub.client.ftp:quote WmPublic. Executes a given FTP command.

pub.client.ftp:rename WmPublic. Renames a file on a remote FTP server. (This service corresponds to the standard FTP command rename.)

pub.client.ftp:sessioninfo WmPublic. Returns session information for all of the FTP servers that users are currently logged into.


serverhost String Name or IP address of the FTP server (for example, ftp.netscape.com).

serverport String Port number of the FTP server (for example, 4566).

username String Valid FTP user of the remote FTP server (for example, anonymous).

password String Valid password of the FTP user.

command String One of the following FTP commands: ls, put, or get.

dirpath String Working directory of the FTP server (for example, /tmp/pub). If the directory does not exist, the server throws an exception.

transfermode String One of the following FTP file transfer modes: ascii or binary. The default is ascii.

transfertype String One of the following FTP data transfer types: passive or active. The default is active.

localfile String When command is set to put, this parameter specifies the name of the local file you want to transfer. (If content is specified, this field is ignored.)

When command is set to get, this parameter specifies the name of the local file in which you want the retrieved content saved.



Output Parameters

pub.cl ient:httpWmPublic. Issues an HTTP request that you specify and returns the HTTP response.

Input Parameters

remotefile String When command is set to put, this parameter specifies the name of the remote file in which you want the save the data you are sending.

When command is set to get, this parameter specifies the name of the remote file that you want to retrieve.

content java.io.InputStream, byte[ ], or String Data to be transferred when command is set to put.

encoding String Optional. Character set in which the document is encoded. Specify an IANA-registered character set (for example, ISO-8859-1).

This information is required to correctly convert the String object to bytes when performing a get. If parameter is null, the default JVM encoding is used.

timeout String Time (measured in seconds) to wait for a response from the FTP server before timing out and aborting the request. Default is to wait forever.

command String FTP command that was executed (ls, get, or put).

dirlist String List File names returned by the ls command.

localfile String Name of the local file used for a get or put operation.

remotefile String Name of the remote file used for a get or put operation.

content byte[ ] If localfile was not specified, this parameter contains the Content object sent to the remote server (if a put command was executed) or received from the remote server (if a get command was executed).

returncode String Standard FTP protocol return code.

returnmsg String Standard FTP protocol return message.

logmsg String FTP log message.

url String URL of the resource that you want to access. For example: http://www.rubicon.com/orders/orders.html

Important! This string must begin with http: or https:.


pub.client:http

method String Specifies the HTTP method you want to use. Valid values are:deleteget headoptionspostputtrace

loadAs String Optional. Form in which you want the http service to store the returned document.

Set to... To...

bytes Default. Return the body of the response as a byte[ ]. Use this option if the body will be used as input to a service that operates on whole HTML or XML documents (for example, pub.xml:queryXMLNode).

stream Return the body of the response as a java.io.InputStream. Use this option if the document will be used as input to a service that can process documents incrementally (for example, Usage Notes).

data Document Data that you want the http service to submit with the HTTP request. Specify data using one or more of the following keys.

Important! When you use more than one key, args is appended first, table is appended second, and string is appended last.



Key Description

args Document Optional. Name=value pairs that you want this service to submit to the resource in url. You can use args to submit data via the POST, GET, or HEAD method.

To specify data using args, create one String element for each name=value pair that you want to submit, where the element’s name represents the name portion of the pair and the element’s value represents the value portion of the pair.

When you use args, the http service will automatically:

URL-encode name=value pair, so you do not need to URL-encode the values you specify in args.

Insert the “&” character between pairs, so you do not need to include it in args.

Prefix the entire query string with the “?” character if it submits the data in args via a GET or HEAD. You do not need to include this character in args.

When you submit data using args, the webMethods Integration Server automatically sets the value of the Content-Type header to application/x-www-form-urlencoded.

If you want to explicitly specify a different Content-Type value, you must submit the value using the string or bytes variable.


pub.client:http

table String Table Optional. Data that the http service will use to construct a query string to submit to the resource specified in url.

table is similar to args, but it allows you to submit unnamed values in a query string, not just name=value pairs.

To specify data using table, create one row for each value that you want to submit, where the contents of column 0 of the String Table represents the name portion of the pair (leave this column null to submit an unnamed value) and the contents of column 1 represents the value portion of the pair.

When you use table, the http service will automatically:

URL-encode name=value pair, so you do not need to URL-encode the values you specify in table.

Insert the “&” character between the pairs (or unnamed values) that it constructs, so you do not need to include it in table.

Prefix the entire query string with the “?” character if it submits the data in table via the GET method. You do not need to include this character in table.

When you submit data using table, the webMethods Integration Server automatically sets the value of the Content-Type header to application/x-www-form-urlencoded. If you want to explicitly specify a different Content-Type, you must submit your data using the string or bytes variable.

string String Optional. Text that you want the http service to submit to the resource in url. You can use string to submit data via the POST, GET, or HEAD method.

If you use string to submit data, make sure that you specify the string exactly as you want it presented in the HTTP request. (If you are using the GET or HEAD method, make sure you URL-encode the contents of string.)

Note: When you use string, the http service will automatically prefix the entire query string with “?” if it submits the data in string via a GET or HEAD. You do not need to include this character in string.

When performing a POST, string will be submitted to the resource defined by url as the body of the request message.



bytes byte[ ] Optional. Data that you want this service to submit to the resource in url. You can use bytes to submit data via the POST method only.

Important! When you use bytes and another element (args, table, or string) to specify data, the service appends the data from the args, table, or string element to url. The service appends args to url first, table second, and string last. The service encodes the data from the bytes element in the body of the post. If the stream variable is not null, bytes is ignored.

mimeStream java.io.InputStream Optional. MIME or SMIME message that you want this service to submit to the resource in url. A mimeStream is created by the pub.mime:getEnvelopeStream, pub.smime:createEncryptedData, or pub.smime:createSignedData services. It contains both headers and content. The headers in the mimeStream are appended to the http headers.

You can use mimeStream to submit data via the POST method only.

stream java.io.InputStream Optional. Data that you want the http service to submit to the resource in url. You can use stream to submit data via the POST method only.

Important! When you use stream and another element (args, table, string or bytes) to specify data, the service appends the data from the args, table, or string element to url. The service appends args to url first, table second, and string last. The service encodes the data from the stream element in the body of the post. If the stream input is not null, the bytes input is ignored.

encoding String Optional. Character set in which the URL data parameters are encoded (args or table and/or string). Encoding is required to correctly convert the String object to bytes when generating the URL for a post. Specify an IANA-registered character set (for example, ISO-8859-1).

If this variable is null, the default JVM encoding is used. Because string is used in the body of the post and not used for building the URL, you do not need to specify encoding for the data parameter string.

auth Document Optional. Authorization information that the http service will submit if the resource specified in url is protected.

Key Description

type String Type of authentication that you want this service to use when it submits this request. The default is Basic.


pub.client:http

Output Parameters

Usage Notes

If url begins with https:, you can use pub.security:setKeyAndChain to specify the certificate chain. If you do not specify a certificate chain, pub.client:http uses the default outbound SSL certificate settings to authenticate the resources.

If pub.client:http does not receive a response within the timeout period specified in the server’s watt.net.timeout parameter, it will throw an exception. For information about the watt.net.timeout parameter, see the webMethods Integration Server Administrator’s Guide.

user String User name that this service will submit when requesting a protected resource.

pass String Password associated with user.

headers Document Optional. Fields that you want to explicitly override in the HTTP request header issued by the http service.

Specify a key in headers for each header field that you want to set, where the key’s name represents the name of the header field and the key’s value represents the value of that header field.

If you do not set headers, the http service uses its default header values.

encodedURL String The URL that was submitted by pub.client:http. This will contain any argument set in args, table, or string.

header Document Conditional. HTTP response headers.

Key Description

lines Document Fields in the response header, where key names represent field names and values represent field values.

status String HTTP status code of the response.

statusMessage String HTTP status message of the response.

body Document Body of the HTTP response.

Key Description

bytes byte[ ] Conditional. Body of the HTTP response represented as a byte[ ]. bytes is returned only when the loadAs input parameter is set to bytes.

stream java.io.InputStream Conditional. The body of the HTTP response represented as an InputStream. stream is returned only when the loadAs input parameter is set to stream.



pub.cl ient:smtpWmPublic. Sends a MIME-type email message.

You may attach one or more content objects or files to the message.

Input Parameters

to String Receiver’s email address. If you specify multiple addresses, separate them with commas.

cc String Optional. Additional receiver’s email addresses. If you specify multiple addresses, separate them with commas.

bcc String Optional. Additional receiver’s email addresses. If you specify multiple addresses, separate them with commas.

subject String Subject of the message.

subjectCharset String Optional. The character set used to encode the MIME message headers (including subject). If subjectCharset is not specified, then charset is used. If charset is not specified, the value in the server parameter watt.server.email.charset is used. If that parameter is not set, the utf-8 encoding is used.

charset String Optional. The character encoding of the body text. If charset is not specified, the value in the server parameter watt.server.email.charset is used. If that parameter is not set, the utf-8 encoding is used.

from String Sender’s email address.

mailhost String SMTP host name for outbound messages. For example: smtp.webMethods.com

mailhostPort String Optional. The number of the port on which the SMTP host listens. This parameter does not need to be set if the host listens on port 25 (the standard SMTP port).

body String The content of the message.

mimeStream java.io.InputStream Optional. MIME or S/MIME message that you want to send in the email. A mimeStream is created by the pub.mime:getEnvelopeStream, pub.smime:createEncryptedData, or pub.smime:createSignedData services. It contains both headers and content. If the mimeStream already contains the from, to, and subject headers, you do not need to pass them as individual inputs to this service.

attachments Document List Optional. Attachments to the message. Each attachment defines one message part in a multi-part message.

Key Description

contenttype String MIME type of the message. For example:application/x-edi-message

content byte[ ], String, or java.io.InputStream Content of the message.


pub.client:soapHTTP

Output Parameters

Usage Notes

If you are using filename to attach a file to the message and the file is not a plain text file, you must set the contenttype and encoding. For example, to attach webMethods6\IntegrationServer\mydir\myfile.doc to a pub.client:smtp service, you would invoke the service with the following values in attachments:

contenttype: application/msword

filename: mydir/myfile.doc

encoding: base64

pub.cl ient:soapHTTPWmPublic. Submits a SOAP message to a server via HTTP or HTTPS.

Input Parameters

filename String Name of a local file to be attached to the message. Used only if content is not specified.

encoding String Optional. Encoding of the message. For example: base64 or 7bit. If encoding is not specified, 7bit is used.

charset String Optional. Character set encoding of the attachment. This value is added to the Content-Type header for the attachment. If charset is not specified, the value in the server parameter watt.server.email.charset is used. If that parameter is not set, the utf-8 encoding is used.

status String Final status of service.

soapRequestData Object SOAP message that is to be sent. This object must be produced with the services in the soap folder. See “Usage Notes” below.

address String URL to which you want the SOAP message sent. For example: https://rubicon:5555/soap/default

auth Document Optional. Parameters specifying the credentials that are to be submitted to the server specified in address. Each element is defined as follows:

Key Description

type String Type of authentication that the service will perform. The default is Basic.

user String User name that this service will use if one is requested.



Output Parameters

pass String Password that this service will submit if one is requested.

validateSOAP String Optional. Indicates whether or not the response message is to be validated against the SOAP schema.

Set to... To...

true Validate the response message and throw an exception if the response does not conform to the SOAP schema.

false Default. Bypass the validation process.

SOAPAction String Optional. Value to which you want to set the SOAPAction HTTP header.

Note: The SOAPAction header was required by the initial SOAP specification but has since been deprecated. The Integration Server does not use the SOAPAction header and accepts SOAP messages that omit it. If you are designing a completely new solution, we recommend that you avoid using the SOAPAction header. However, if you exchange SOAP messages with systems that require a SOAPAction header, this parameter allows you to set it.

soapResponseData Object The SOAP response message returned by the server specified in address.

header Document Conditional. Headers from the HTTP response. Will contain the following keys:

Key Description

lines Document Header fields from the HTTP response. Each key in lines represents a field (line) of the response header. Key names represent the names of header fields. The keys’ values are Strings containing the values of the fields.

status String Status code from the HTTP response.

statusMessage String Status message from the HTTP response.

soapStatus String Flag indicating whether the SOAP request message was processed successfully.

A value of... Indicates that...

0 The remote server successfully processed the SOAP request and returned a SOAP response message.

1 The remote server returned a SOAP fault, indicating that the SOAP request was received but was not processed successfully.


pub.client:soapRPC

Usage Notes

If address begins with https:, you can use pub.security:setKeyAndChain to specify the certificate chain. If you do not specify a certificate chain, pub.client:soapHTTP uses the default outbound SSL certificate settings to authenticate the resources.

To send a SOAP message with this service, you must first generate an empty SOAP object with the pub.soap.utils:createSoapData service and then populate it using services such as pub.soap.utils:addHeaderEntry and pub.soap.utils:addBodyEntry. For information about creating and sending SOAP messages, see the SOAP Developer’s Guide.

See Also

pub.client:soapRPC

Examples

sample.soap:buildMsg_sendHTTP

pub.cl ient:soapRPCWmPublic. Submits a SOAP remote procedure call via HTTP or HTTPS.

Input Parameters

2 The server returned an error that was not a SOAP fault. This indicates that some type of HTTP error occurred (often, an HTTP 404). You can check the status element in header to determine the type of HTTP error that occurred.

address String String specifying the numeric address or name of the server on which the remote procedure resides. If you are submitting the request to a webMethods Integration Server, remember to direct it to the RPC processor as shown in the following example:

http://rubicon:5555/soap/rpc

reqParms Document The input parameters that are to be passed to the remote procedure. For example, if you wanted to pass three String parameters, acct, amt, and org, containing the values Cash, 150.00, and Sales, reqParms would contain the following:

Key Value

acct Cash

amt 150.00

org Sales

method Document The QName of the requested procedure where:



Output Parameters

Key Value

namespaceName String Namespace portion of the procedure’s QName.

localName String Local portion of the procedure’s QName.

auth Document Optional. User name and password that are to be submitted to the server specified in address.

Key Value

type String Type of authentication that the service will perform. The default is Basic.

user String User name that this service will use if one is requested.

pass String Password that this service will submit if one is requested.

targetInputSignature String Optional. Fully qualified name of the IS document type to use to validate and encode the contents of reqParms.

targetOutputSignature String Optional. Fully qualified name of the IS document type to use to validate and decode the output value returned by the remote procedure.

SOAPAction String Optional. Value to which you want to set the SOAPAction HTTP header.

Note: The SOAPAction header was required by the initial SOAP specification but has since been deprecated. The Integration Server does not use the SOAPAction header and accepts SOAP messages that omit it. If you are designing a completely new solution, we recommend that you avoid using the SOAPAction header. However, if you exchange SOAP messages with systems that require a SOAPAction header, this parameter allows you to set it.

soapResponseData Object A SOAP object containing the SOAP response message returned by the server specified in address.

respParms Document Output parameters returned by the remote procedure. For example, if the remote procedure returned two String parameters, status and balance, containing the values closed and –4.95, respParms would contain the following:

Key Value

status closed

balance -4.95

header Document Conditional. Headers from the HTTP response. Will contain the following keys:


pub.client.ftp:append

Usage Notes

If address begins with https:, you can use pub.security:setKeyAndChain to specify the certificate chain. If you do not specify a certificate chain, pub.client:soapRPC uses the default outbound SSL certificate settings to authenticate the resources.

See Also

pub.client:soapHTTP

Examples

sample.soap:buildRPC_SendHTTPSimple

pub.cl ient . f tp:appendWmPublic. Appends data to a remote file.

If the remote file does not exist, the service creates the file.

Input Parameters

Key Value

lines Document Header fields from the HTTP response. Each key in lines represents a field (line) of the response header. Key names represent the names of header fields. The keys’ values are Strings containing the values of the fields.

status String Status code from the HTTP response.

statusMessage String Status message from the HTTP response.

soapStatus String Flag indicating whether the SOAP request message was processed successfully.


0 The remote server successfully processed the SOAP request and returned a SOAP response message.

1 The remote server returned a SOAP fault, indicating that the SOAP request was received but was not processed successfully.

2 The server returned an error that was not a SOAP fault. This indicates that some type of HTTP error occurred (often, an HTTP 404). You can check the status field in header to determine the type of HTTP error that occurred.

sessionkey String Unique key for the current FTP session. The sessionkey is returned by the pub.client.ftp:login service.



Output Parameters

pub.cl ient . f tp:cdWmPublic. Changes the working directory on the FTP server. (This service corresponds to the standard FTP command cd dirpath.)

Input Parameters

Output Parameters

pub.cl ient . f tp:cdlsWmPublic. Changes the working directory on the FTP server and retrieves a list of file names. (This service corresponds to the standard FTP commands cd dirpath and ls namePattern.)

Input Parameters

transfermode String FTP file transfer mode (ascii or binary). The default is ascii.

content java.io.InputStream, byte[ ], or String Data to be transferred to the remote file.

localfile String Optional. Name of the local file to append to the remote file. Used only when content is not specified.

remotefile String Name of the remote file to which to append the data specified in content or localfile.



logmsg String FTP log messages for the entire user session.


dirpath String Directory to which you want to switch on the FTP server. For example: pub






pub.client.ftp:delete

Output Parameters

pub.cl ient . f tp:deleteWmPublic. Deletes a file in the current working directory on an FTP server. (This service corresponds to the standard FTP command delete somefile.)

Input Parameters

Output Parameters

pub.cl ient . f tp:dirWmPublic. Retrieves the file list during an FTP session. (This service corresponds to the standard FTP command dir namepattern.)

Input Parameters

dirpath String Directory to which you want to switch on the FTP server (for example, pub).

filenamepattern String Optional. Pattern that specifies the file names to list (for example, *.txt).

dirlist String List List of file names matching filenamepattern.





remotefile String Name of the file to be deleted from the current working directory. For example: text.txt

If you specify pattern-matching characters in remotefile, all files matching the pattern will be deleted.







Output Parameters

pub.cl ient . f tp:getWmPublic. Retrieves a file from a remote FTP server. (This service corresponds to the standard FTP command get.)

Input Parameters

Output Parameters

filenamepattern String Optional. Pattern that specifies the names of the files to include in the list (for example, *.txt).







localfile String Optional. Name of a local file where the retrieved file is to be saved.

remotefile String Name of the remote file.

encoding String Optional. Character set in which the file is encoded. This variable is required to convert the file to bytes correctly. Specify an IANA-registered character set (for example: ISO-8859-1).

If this variable is null, the encoding currently set for the FTP session is used. If encoding was never set for this FTP session, the default JVM encoding is used.

content byte[ ] Data retrieved from the remote file.





pub.client.ftp:login

pub.cl ient . f tp: loginWmPublic. Connects to a remote FTP server and logs in with a specified user name and password.

You must use this service to initiate an FTP session before using most other services in pub.client.ftp.

Input Parameters

Output Parameters

serverhost String Name or IP address of the FTP server (for example, ftp.netscape.com).

serverport String Port number on which the FTP server listens for requests (for example, 4566).

The default is 21.

dataport String Optional. Listener port number of the data transfer channel (for example, 3345).

If you do not specify dataport, the Integration Server will choose the listener port number. This value is used only when the transfertype value is active.

username String Valid FTP user on the remote FTP server (for example, anonymous).

password String Valid password for the FTP user specified in username (for example, someone@somewhere).

account String Optional. The user name for an account on the FTP server. Specify account if your FTP host requires account information. The account is defined in the FTP protocol to further identify the user that is identified by the username and password input variables.

transfertype String Type of the FTP data transfer mode (passive or active). The default is active.

encoding String Optional. Default character set for encoding data transferred during this session. Specify an IANA-registered character set (for example, ISO-8859-1).

If you do not set encoding, the default JVM encoding is used.

timeout String Optional. Time (measured in seconds) to wait for a response from the FTP server before timing out and terminating the request. The default is to wait forever.

sessionkey String Unique key for the current FTP session. This session key must be provided to execute most other services in pub.client.ftp.






pub.cl ient . f tp: logoutWmPublic. Logs off of the FTP server and ends the current FTP session.

Input Parameters

Output Parameters

pub.cl ient . f tp: lsWmPublic. Retrieves the file list during an FTP session. (This service corresponds to the standard FTP command ls namepattern.)

Input Parameters

Output Parameters






filenamepattern String Optional. Pattern that specifies the names of the files to include in the list (for example, *.txt).






pub.client.ftp:mdelete

pub.cl ient . f tp:mdeleteWmPublic. Deletes multiple files in the current working directory on an FTP server. (This service corresponds to the standard FTP command mdelete pattern.)

Input Parameters

Output Parameters

pub.cl ient . f tp:mgetWmPublic. Transfers multiple files from the remote FTP server. (This service corresponds to the standard FTP command mget.)

Input Parameters


filenamepattern String Pattern that specifies the names of the files to be deleted from the current working directory (for example, *.txt).

Important! If you do not specify a value for filenamepattern, all files in the working directory are deleted.






localdir String Directory in the local file system where the retrieved files are to be saved (for example, c:\temp\ftpfiles).

filenamepattern String Pattern that specifies the names of the files to be retrieved (for example, *.txt).

encoding String Optional. Character set in which the files are encoded. This variable is required to convert the files to bytes correctly. Specify an IANA-registered character set (for example, ISO-8859-1).

If you do not specify encoding, the encoding assigned to the FTP session is used. If the encoding was not set for the FTP session, the default JVM encoding is used.



Output Parameters

pub.cl ient . f tp:mputWmPublic. Transfers multiple files to a remote FTP server. (This service corresponds to the standard FTP command mput.)

Input Parameters

Output Parameters

pub.cl ient . f tp:putWmPublic. Transfers a file to a remote FTP server. (This service corresponds to the standard FTP command put.)

Input Parameters

filenames String List List of files retrieved from the remote FTP server.






localdir String Local directory containing the files you want to transfer to the remote FTP server (for example, c:\temp\ftpfiles).

filenamepattern String Pattern that specifies the names of the files to be transferred (for example, *.txt).

filenames String List List of files transferred to the remote FTP server.







pub.client.ftp:quote

Output Parameters

pub.cl ient . f tp:quoteWmPublic. Executes a given FTP command.

You can use this service to execute non-standard FTP commands.

Input Parameters

Output Parameters

pub.cl ient . f tp:renameWmPublic. Renames a file on a remote FTP server. (This service corresponds to the standard FTP command rename.)

Input Parameters

content java.io.InputStream, byte[ ], or String Data to be transferred to the remote file.

localfile String Optional. Name of the local file to be appended to the remote file. Used only if content is not specified.

remotefile String The name of the remote file.





string String The command to be executed on the FTP server. This service submits the command exactly as it is specified in string.







Output Parameters

pub.cl ient . f tp:sessioninfoWmPublic. Returns session information for all of the FTP servers that users are currently logged into.

Input Parameters

Output Parameters

oldname String Fully qualified name of the file you want to rename (for example, temp/oldname.txt).

newname String New fully qualified name for the file (for example, temp/newname.txt).




name Not used. Reserved for future use.

sessioninfo Document List Information about the current FTP sessions. Each document in sessioninfo represents a single session and contains the following information:

Key Description

serverhost String Name or IP address of the FTP server.

serverport String Port number on which the FTP server listens for requests.

dataport String Listener port of the data transfer channel used by this session.

username String User logged on to FTP server.

password String Password for the FTP user specified in username.

account String Conditional. The user name for an account on the FTP server. The account is defined in the FTP protocol to further identify the user that is identified by the username and password input variables.

transfertype String Data transfer mode (passive or active) used by this session.

encoding String Conditional. IANA character set used by this session. If encoding is not returned, the encoding was not explicitly set and the default JVM encoding is in effect.


C H A P T E R3
Cluster Folder
You use the elements in the cluster folder to enable and/or disable load balancing for specific services and sessions in a cluster.


C H A P T E R 3 C l u s t e r F o l d e r


pub.cluster:disableServiceRedirWmPublic. Enables or disables load balancing for a service.

Disabling load balancing for a service guarantees that an invocation of that service will not be redirected to another server.

Input Parameters

Output Parameters

None.

pub.cluster:disableSessionRedirWmPublic. Enables or disables load balancing for the current session.

Disabling load balancing for a session guarantees that invocations of services within that session will not be redirected to another server.


pub.cluster:disableServiceRedir WmPublic. Enables or disables load balancing for a service.

pub.cluster:disableSessionRedir WmPublic. Enables or disables load balancing for the current session.

pub.cluster:getClusterHosts WmPublic. Returns a list of servers in the cluster.

redir String Optional. Enables or disables load balancing for the service.

Set to... To...

true Enable load balancing for a service.

false Default. Disable load balancing for a service.

service String The fully qualified name of the service for which load balancing is to be enabled or disabled.


pub.cluster:getClusterHosts

Input Parameters

Output Parameters

None.

pub.cluster:getClusterHostsWmPublic. Returns a list of servers in the cluster.

Input Parameters

None.

Output Parameters

Usage Notes

The hostExternal address may or may not be the same as hostAddress. The hostAddress is used to refer to the server from inside the firewall, while the hostExternal address is used to refer to the server from outside of the firewall (such as when network address translation is done at the firewall).

redir String Optional. Enables or disables load balancing for the session.

Set to... To...

true Enable load balancing for the current session.

false Default. Disable load balancing for the current session.

hosts Document List Conditional. Servers in the cluster.

Key Description

hostExternal String Address of the server as known outside of the firewall.

hostAddress String Configured IP address for the server.

port String Primary HTTP port.

sport String Primary HTTPS port.


C H A P T E R 3 C l u s t e r F o l d e r


C H A P T E R4
Date Folder
You use the elements in the date folder to generate and format date values.


C H A P T E R 4 D a t e F o l d e r


Pattern String Symbols

Many of the date services require you to specify pattern strings describing the data’s current format and/or the format to which you want it converted. For services that require a pattern string, use the symbols in the following table to describe the format of your data. For example, to describe a date in the January 15, 1999 format, you would use the pattern string MMMMM dd, yyyy. To describe the format 01/15/99, you would use the pattern string MM/dd/yy. For more information about these pattern string symbols, see the Sun Java API documentation for the SimpleDateFormat class.


pub.date:currentDate WmPublic. Deprecated—Use pub.date:getCurrentDate or pub.date:getCurrentDateString. Returns the current date as a String in a specified format.

pub.date:dateBuild WmPublic. Builds a date/time String using the specified pattern and the specified date elements.

pub.date:dateTimeBuild WmPublic. Builds a date/time string using the specified pattern and the specified date elements.

pub.date:dateTimeFormat WmPublic. Converts date/time (represented as a String) string from one format to another.

pub.date:formatDate WmPublic. Formats a Date object as a string.

pub.date:getCurrentDate WmPublic. Returns the current date as a Date object.

pub.date:getCurrentDateString WmPublic. Returns the current date as a String in a specified format.

Symbol Meaning Presentation Example

G era designator Text AD

y year Number 1996 or 96

M month in year Text or Number July or Jul or 07

d day in month Number 10

h hour in am/pm (1–12) Number 12

H hour in day (0–23) Number 0

m minute in hour Number 30

s second in minute Number 55

S millisecond Number 978


Time Zones

When working with date services, you can specify time zones. The Earth is divided into 24 standard time zones, one for every 15 degrees of longitude. Using the time zone including Greenwich, England (known as Greenwich Mean Time, or GMT) as the starting point, the time is increased by an hour for each time zone east of Greenwich and decreases by an hour for each time zone west of Greenwich. The time difference between a time zone and the time zone including Greenwich, England (GMT) is referred to as the raw offset.

The following table identifies the different time zones for the Earth and the raw offset for each zone from Greenwich, England. The effects of daylight savings time are ignored in this table.

Note: Greenwich Mean Time (GMT) is also known as Universal Time (UT).

E day in week Text Tuesday or Tue

D day in year Number 189

F day of week in month Number 2 (2nd Wed in July)

w week in year Number 27

W week in month Number 2

a am/pm marker Text PM

k hour in day (1–24) Number 24

K hour in am/pm (0–11) Number 0

z time zone Text Pacific Standard Time or PST or GMT-08:00

Z RFC 822 time zone (JVM 1.4 or later)

Number -0800 (offset from GMT/UT)

' escape for text Delimiter

' ' single quote Literal '

ID Raw Offset Name

MIT -11 Midway Islands Time

HST -10 Hawaii Standard Time

AST -9 Alaska Standard Time

PST -8 Pacific Standard Time

PNT -7 Phoenix Standard Time

MST -7 Mountain Standard Time

Symbol Meaning Presentation Example



Examples

You can specify timezone input parameters in the following formats:

As a full name. For example:

CST -6 Central Standard Time

EST -5 Eastern Standard Time

IET -5 Indiana Eastern Standard Time

PRT -4 Puerto Rico and U.S. Virgin Islands Time

CNT -3.5 Canada Newfoundland Time

AGT -3 Argentina Standard Time

BET -3 Brazil Eastern Time

GMT 0 Greenwich Mean Time

ECT +1 European Central Time

CAT +2 Central Africa Time

EET +2 Eastern European Time

ART +2 (Arabic) Egypt Standard Time

EAT +3 Eastern African Time

MET +3.5 Middle East Time

NET +4 Near East Time

PLT +5 Pakistan Lahore Time

IST +5.5 India Standard Time

BST +6 Bangladesh Standard Time

VST +7 Vietnam Standard Time

CTT +8 China Taiwan Time

JST +9 Japan Standard Time

ACT +9.5 Australian Central Time

AET +10 Australian Eastern Time

SST +11 Solomon Standard Time

NST +12 New Zealand Standard Time

Asia/Tokyo America/Los_Angeles

ID Raw Offset Name


pub.date:currentDate

You can use the java.util.TimeZone.getAvailableIDs() method to obtain a list of the valid full name time zone IDs that your JVM version supports.

As a custom time zone ID, in the format GMT[+ | -]hh[ [:]mm]. For example:

As a three-letter abbreviation from the table above. For example:

Note: Because some three-letter abbreviations can represent multiple time zones (for example, “CST” could represent both U.S. “Central Standard Time” and “China Standard Time”), all abbreviations are deprecated. Use the full name or custom time zone ID formats instead.

Notes on Invalid Dates

If you use an invalid date with a date service, the date service automatically translates the date to a legal date. For example, if you specify “1999/02/30” as input, the date service interprets the date as “1999/03/02” (two days after 2/28/1999).

If you use “00” for the month or day, the date service interprets “00” as the last month or day in the Gregorian calendar. For example, if you specify “00” for the month, the date service interprets it as 12.

If the pattern yy is used for the year, the date service uses a 50-year moving window to interpret the value of yy. The date service establishes the window by subtracting 49 years from the current year and adding 50 years to the current year. For example, if you are running the webMethods Integration Server in the year 2000, the moving window would be from 1951 to 2050. The date service interprets 2-digit years as falling into this window (for example, 12 would be 2012, 95 would be 1995).

pub.date:currentDateWmPublic. Deprecated—Use pub.date:getCurrentDate or pub.date:getCurrentDateString. Returns the current date as a String in a specified format.

Input Parameters

GMT+2:00 All time zones 2 hours east of Greenwich (that is, Central Africa Time, Eastern European Time, and Egypt Standard Time)

GMT-3:00 All time zones 3 hours west of Greenwich (that is, Argentina Standard Time and Brazil Eastern Time)

GMT+9:30 All time zones 9.5 hours east of Greenwich (that is, Australian Central Time)

PST Pacific Standard Time

pattern String Pattern representing the format in which you want the date returned. For pattern-string notation, see “Pattern String Symbols” on page 66.



Output Parameters

pub.date:dateBui ldWmPublic. Builds a date/time String using the specified pattern and the specified date elements.

Input Parameters

Output Parameters

timezone String Optional. Time zone in which you want the output date and time expressed. Specify a time zone code as shown in “Time Zones” on page 67 (for example, EST for Eastern Standard Time).

If you do not specify timezone, the value of the server’s “user timezone” property is used. If this property has not been set, GMT is used.

value String Current date in the format of pattern.

pattern String Pattern representing the format in which you want the date returned. For pattern-string notation, see “Pattern String Symbols” on page 66. If you do not specify pattern, dateBuild returns null. If pattern contains a time zone and timezone is not specified, the webMethods Integration Server’s default time zone is used.

year String Optional. The year expressed in yyyy or yy format (for example, 01 or 2001). If you do not specify year or you specify an invalid value, dateBuild uses the current year.

month String Optional. The month expressed as a number (for example, 1 for January, 2 for February). If you do not specify month or you specify an invalid value, dateBuild uses the current month.

dayofmonth String Optional. The day of the month expressed as a number (for example, 1 for the first day of the month, 2 for the second day of the month). If you do not specify dayofmonth or you specify an invalid value, dateBuild uses the current day.



locale String Optional. Locale in which the date is to be expressed. For example, if locale is en (for English), the pattern EEE d MMM yyyy will produce Friday 23 August 2002, and the locale of fr (for French) will produce vendredi 23 août 2002.

value String The date specified by year, month, and dayofmonth, in the format of pattern.


pub.date:dateTimeBuild

pub.date:dateTimeBui ldWmPublic. Builds a date/time string using the specified pattern and the specified date elements.

Input Parameters

Output Parameters

pattern String Pattern representing the format in which you want the time returned. For pattern-string notation, see “Pattern String Symbols” on page 66. If you do not specify pattern, dateTimeBuild returns null. If pattern contains a time zone and the timezone parameter is not set, the webMethods Integration Server’s time zone is used.

year String Optional. The year expressed in yyyy or yy format (for example, 01 or 2001). If you do not specify year or you specify an invalid value, dateTimeBuild uses the current year.

month String Optional. The month expressed as a number (for example, 1 for January, 2 for February). If you do not specify month or you specify an invalid value, dateTimeBuild uses the current month.

dayofmonth String Optional. The day of the month expressed as a number (for example, 1 for the first day of the month, 2 for the second day of the month). If you do not specify dayofmonth or you specify an invalid value, dateTimeBuild uses the current day.

hour String Optional. The hour expressed as a number based on a 24-hour clock (for example, 0 for midnight, 2 for 2am, 14 for 2pm). If you do not specify hour or you specify an invalid value, dateTimeBuild uses 0 as the hour value.

minute String Optional. Minutes expressed as a number. If you do not specify minute or you specify an invalid value, dateTimeBuild uses 0 as the minute value.

second String Optional. Seconds expressed as a number. If you do not specify second or you specify an invalid value, dateTimeBuild uses 0 as the second value.

millis String Optional. Milliseconds expressed as a number. If you do not specify millis or you specify an invalid value, dateTimeBuild uses 0 as the millis value.




value String Date and time in format of pattern.



pub.date:dateTimeFormatWmPublic. Converts date/time (represented as a String) string from one format to another.

Input Parameters

Output Parameters

Usage Notes

As described in “Notes on Invalid Dates” on page 69, if the pattern yy is used for the year, dateTimeFormat uses a 50-year moving window to interpret the value of the year. If you need to change this behavior so that the year is interpreted as 80 years before or 20 years after the current date (as described in the Java class java.text.SimpleDateFormat), set the server configuration parameter watt.server.pubDateTimeFormat.javaSlidingWindow to true. For information about setting configuration parameters, see the webMethods Integration Server Administrator’s Guide.

If currentPattern does not contain a time zone, the value is assumed to be in the time zone of the webMethods Integration Server.

If newPattern contains a time zone, the time zone of the webMethods Integration Server is used.

pub.date:formatDateWmPublic. Formats a Date object as a string.

Input Parameters

inString String Date/time that you want to convert.

Important! If inString contains a character in the last position, that character is interpreted as 0. This can result in an inaccurate date. For information about invalid dates, see page 69.

currentPattern String Pattern string that describes the format of inString. For pattern-string notation, see “Pattern String Symbols” on page 66.

newPattern String Pattern string that describes the format in which you want inString returned. For pattern-string syntax, see “Pattern String Symbols” on page 66.


value String The date/time given by inString, in the format of newPattern.

date java.util.Date Optional. Date/time that you want to convert.


pub.date:getCurrentDate

Output Parameters

pub.date:getCurrentDate WmPublic. Returns the current date as a Date object.

Input Parameters

None.

Output Parameters

pub.date:getCurrentDateStr ingWmPublic. Returns the current date as a String in a specified format.

Input Parameters

pattern String Pattern string that describes the format in which you want the date returned. For pattern-string notation, see “Pattern String Symbols” on page 66.




value String The date/time given by date in the format specified by pattern.

date java.util.Date Current date.

pattern String Pattern representing the format in which you want the date returned. For pattern-string notation, see “Pattern String Symbols” on page 66.





Output Parameters


value String Current date in the format specified by pattern.


C H A P T E R5
Db Folder
You use the elements in the db folder to access JDBC-enabled databases.

Note: The webMethods JDBC adapter also provides services that perform operations against JDBC-enabled databases. See the JDBC Adapter User Guide for information.


C H A P T E R 5 D b F o l d e r



pub.db:call WmDB. Invokes a stored procedure on a target database. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:clearTransaction WmDB. Clears the transactional state within a database connection. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:close WmDB. Closes a specified database connection. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:closeAll WmDB. Closes all database connections that the session has opened. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:commit WmDB. Commits changes to a database. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:connect WmDB. Creates a connection to the database using the supplied JDBC URL, user name, and password. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:delete WmDB. Removes all rows in the specified table that meet the given criteria. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:execSQL WmDB. Executes the specified SQL statement. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:getProcInfo WmDB. Retrieves information about one or more stored procedures. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:getProcs WmDB. Retrieves the names of stored procedures for the specified database. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:getTableInfo WmDB. Retrieves information about columns in the specified table. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:getTables WmDB. Retrieves the names of tables in the specified database and schema. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.


pub.db:call

pub.db:cal lWmDB. Invokes a stored procedure on a target database. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters

pub.db:insert WmDB. Inserts one or more rows into the specified table. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:query WmDB. Retrieves all rows from the specified table that meet the given criteria. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:rollback WmDB. Discards changes to a database. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:startTransaction WmDB. Begins a transaction on a database connection. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

pub.db:update WmDB. Updates all rows in a table that meet the given criteria. Rows are updated with the supplied new data. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.


You may specify the connection parameters in one of the following ways:

$dbAlias

–OR–

$dbURL, $dbUser, $dbPass, $dbDriver

–OR–

$dbConnection

$dbAlias String Optional. Alias of the database on which you want to execute the stored procedure.

$dbURL String Optional. JDBC URL that identifies the database resource.

$dbUser String Optional. User name to use to log into the database.

$dbPass String Optional. Password for the user specified in $dbUser.

$dbDriver String Optional. Name of the JDBC driver to use.



$dbConnection com.wm.app.b2b.server.DBConnection Optional. Connection object returned by pub.db:connect.

$dbCatalog String Optional. Name of the database’s system catalog. Include this parameter if your DBMS supports distributed databases and you want to invoke a stored procedure from a database other than the one to which you are connected.

If you are not using a distributed database system, you do not need to specify this parameter.

If you are running against DB2, use this parameter to specify the stored procedure’s location.

$dbSchemaPattern String Optional. Name of the schema to which the stored procedure belongs.

If your database supports pattern-matching on schemas, you may specify the schema name with a pattern-matching string, where _ represents a single character and % represents any string of characters. For example, the value of HR% would represent any schema beginning with characters HR.

If you are running against DB2, you use this parameter to specify the stored procedure’s AuthID.

$dbProc String The name of the stored procedure you want to invoke.

$dbProcSig Document List Optional. Set of parameters containing information about the stored procedure you want to invoke.

Key Description

name String Parameter name defined in the stored procedure.

sqlType String Type of procedure parameter for name as defined in the database. Set to one of the following values: BIT TINYINTSMALLINT INTEGERBiGINT FLOATREAL DOUBLENUMBERIC DECIMALCHAR VARCHARLONGVARCHAR DATETIME TIMESTAMPBINARY VARBINARYLONGVARBINARY NULL

direction String Way in which the parameter is used by the stored procedure. Set to one of the following values: inoutinoutreturn value


pub.db:clearTransaction

Output Parameters

Usage Notes

The output will also contain output parameters and procedure return values (the return value is called RETURN_VALUE).

pub.db:clearTransact ionWmDB. Clears the transactional state within a database connection. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters

$dbParamsByOrder String Optional. Indicates whether the contents of $data should be sent to the database in order.

Set to... To...

true Send the contents of $data to the database in the order they are listed in $data.

false Default. Send the contents of $data to the database in no particular order.

$data Document Optional. Parameter values for the stored procedure.

$dbMessage String Conditional. Message indicating the success or failure of the operation.


$dbAlias

–OR–


–OR–

$dbConnection

$dbAlias String Optional. Alias of the database connection on which you want to clear the transactional state. The alias is passed automatically if the database is connected.



$dbPass String Optional. Password for the user.




Output Parameters

Usage Notes

On some databases, exceptional conditions within transactions will automatically abort the entire transaction. When this happens, the standard commit/rollback operations are meaningless because there is no current transaction. If this occurs, use the clearTransaction service to clear the transactional state and prepare for a new transaction. You should only use this service if you have begun a transaction and cannot end it with a standard commit or rollback.

The clearTransaction service does not involve a database operation; it is entirely internal to the webMethods Integration Server.

pub.db:closeWmDB. Closes a specified database connection. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters


$dbMessage String A message indicating the success or failure of the operation.


$dbAlias

–OR–


–OR–

$dbConnection

$dbAlias String Optional. Database alias.







pub.db:closeAll

Output Parameters

pub.db:closeAl lWmDB. Closes all database connections that the session has opened. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters

None.

Output Parameters

pub.db:commitWmDB. Commits changes to a database. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters

$closeDbConnection String Optional. Indicates whether to remove the database connection from the pool or return it to the pool for future use.

Set to... To...

true Close the connection and remove it from the pool.

false Default. Close the connection and return it to the pool for future use.

$dbMessage String Message indicating the success or failure of the operation.



$dbAlias

–OR–


–OR–

$dbConnection

$dbAlias String Optional. Alias of the database on which you want to commit changes. The alias is passed automatically if the database is connected.



Output Parameters

Usage Notes

This service returns an exception if an error occurs when committing changes to the database. The most common reason for this error is that no transaction has been started (see pub.db:startTransaction).

pub.db:connectWmDB. Creates a connection to the database using the supplied JDBC URL, user name, and password. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

You can also specify a JDBC driver specific to the database.

Input Parameters








$dbAlias

–OR–


–OR–

$dbURL, $dbDriver, $dbProperties







pub.db:connect

Output Parameters

Usage Notes

Database connections opened by pub.db:connect are associated with the current session.

Multiple attempts to connect to the same database by the same client will result in the same connection being reused. This means that if client A and client B request connections to the same database, they each get their own new connection. If client A makes another call to pub.db:connect, the previous connection is reused. Associating the database connection with the client session prevents remote clients from having to reconnect repeatedly to a target database.

Connections are not pooled or shared across sessions. Unless explicitly closed (by calling pub.db:close or pub.db:closeAll), connections associated with a session are closed when the session is flushed from memory. This happens at a regular interval, which can be configured using the Integration Server Administrator. For more information about setting the session timeout limit, see the webMethods Integration Server Administrator’s Guide.

$dbProperties Document Optional. Set of connection parameters that are to be used to make the database connection. Within $dbProperties, key names represent the names of the connection parameters that are to be used to establish the connection, and the value of a key specifies the value of that particular parameter.

In most cases, you will include the keys user and password in $dbProperties to specify the user name and password parameters that are to be used to connect to the database. You may include additional parameters as needed.

The following example shows how $dbProperties would look if you wanted to set the weblogic.codeset parameter to GBK in order to extract Unicode data out of the database:

Key Value

user dbu

password dbu

weblogic.codeset GBK

$dbConnection com.wm.app.b2b.server.DBConnection Connection object.




pub.db:deleteWmDB. Removes all rows in the specified table that meet the given criteria. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters


$dbAlias

–OR–


–OR–

$dbConnection







$dbCatalog String Optional. Name of the database’s system catalog. Include this parameter if your DBMS supports distributed databases and you want to delete rows from a table that is not in the database to which you are connected.

If you are not using a distributed database system or if you want to delete rows from the database to which you are connected, you do not need to specify this parameter.

If you are running against DB2, use this parameter to specify the database location.

$dbSchemaPattern String Optional. Name of the schema to which the table belongs.

If your database supports pattern-matching on schemas, you may specify the schema name with a pattern-matching string, where _ represents a single character and % represents any string of characters. For example, the value HR% would represent any schema beginning with the characters HR.

If you are running against DB2, you use this parameter to specify the table’s AuthID.

$dbTable String Name of the table to remove rows from.


pub.db:execSQL

Output Parameters

pub.db:execSQLWmDB. Executes the specified SQL statement. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

The service does not perform any parsing on the SQL statement.

Input Parameters

$data Document Optional. Criteria that the rows to delete must meet.

Important! If no criteria are provided, all rows are deleted from the table.

$updateCount String Number of rows deleted.



$dbAlias

–OR–


–OR–

$dbConnection









$dbCatalog String Optional. Name of the database’s system catalog. Include this parameter if your DBMS supports distributed databases and you want to retrieve information from a database to which you are not currently connected.






$dbSQL String SQL statement to execute.

$dbProcessEsc String Optional. Flag that indicates whether JDBC SQL escapes will be processed. These escapes allow database-independent access to database-dependent functionality. For example, different dialects of SQL have different syntax for date literals. Using a JDBC escape, you can encode a date literal in a SQL string that should work on any database. Documentation on JDBC SQL escapes is widely available.

Set to... To...

true Default. Process JDBC SQL escapes.

false Skip processing JDBC SQL escapes.

$dbProcessReporterTokens String Optional. Flag that indicates whether reporter tags (for example, %value xxx%) will be processed in the SQL. Including these tokens in your SQL allows dynamic construction of complex SQL statements, at the possible expense of some execution speed.

Set to... To...

true Process tags.

false Default. Ignore tags.

$dbParamValues Object List Optional. If the “?” parameters in the SQL statement are not supplied indirectly (with the $dbParamNames parameter), they can be supplied directly via this parameter. See “Usage Notes” below. Objects in $dbParamValues can be of any type.


pub.db:execSQL

Output Parameters

Usage Notes

This service does not support updates from a Web browser or HTML form.

SQL supports host variables (“?”) in statements to be executed. Because the pipeline is based on named values and individual host variables are not named, $dbParamNames and $dbParamTypes are used to supply an index-to-name mapping for each SQL statement executed. For example, consider the following SQL query:

SELECT * FROM royalties WHERE pub_id = ? and roy_amt > ?

To execute this SQL query, you could supply the following values to the pub.db:execSQL service:

$dbParamNames String List Optional. Names of any “?” parameters in the SQL. See “Usage Notes” below.

$dbParamTypes String List Optional. SQL type names for each parameter. Use type names from the JDBC 1.2 specification ( “INTEGER”, “VARCHAR”, etc.).

sql String Conditional. SQL as it was actually passed to the target database. This can be helpful in debugging calls to this service when dynamic SQL is used (that is, you are using either JDBC SQL escapes or webMethods Reporter tokens in your SQL).

paramsAsStrings String List Conditional. Values used for each of the parameters in the SQL statement. This can be helpful in debugging calls to this service when “?” parameters are being used.

$rowCount String Conditional. Number of rows in results.

results com.wm.util.Table Conditional. Results from the SQL statement. The Integration Server recognizes and treats this parameter as a Document List at run time.

$updateCount String Conditional. Number of rows updated.


Key Value Description

$dbSQL SELECT * FROM royalties WHERE pub_id = ? and roy_amt > ?

SQL query to execute.

$dbParamNames pub_idroy_amt

Pipeline items to use for the host variables.

$dbParamTypes varcharinteger

SQL types for the host variables.

pub_id P1053 Values for the host variables.



Example: Consider the following SQL query, which contains an INSERT with three host variables: INSERT INTO books VALUES (?, ?, ?)

To execute this SQL query, you could supply the following values to the pub.db:execSQL service:

roy_amt 10 Values for the host variables.

Note: Even if there is only one host variable in the SQL statement, both $dbParamNames and $dbParamTypes are String arrays.


$dbSQL INSERT INTO books VALUES (?, ?, ?) SQL query to execute.

$dbParamNames book_idpub_idbook_title

Pipeline items to use for the host variables.

$dbParamTypes varcharvarcharvarchar

SQL types for the host variables.

book_id B234 Values for the host variables.

pub_id P1053 Values for the host variables.

book_title The Importance of Being Earnest Values for the host variables.

Note: The SQL type names used in the examples are defined in the java.sql.Types and SQL92. Even if you used an Oracle database, which calls long string types “varchar2,” you would call them varchar. The standard names from SQL92 will be mapped into database-specific type names.



pub.db:getProcInfo

pub.db:getProcInfoWmDB. Retrieves information about one or more stored procedures. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters


$dbAlias

–OR–


–OR–

$dbConnection







$dbCatalog String Optional. Name of the database’s system catalog. Include this parameter if your DBMS supports distributed databases and you want to retrieve information about a stored procedure that is not in the database to which you are currently connected.


If you are running against DB2, use this parameter to specify the stored procedure’s location.



If you are running against DB2, you use this parameter to specify the stored procedure’s AuthID.

$dbProc String Name of the procedure about which you want information.



Output Parameters

This service returns one document (IData object) for each item in the stored procedure’s signature that matches the specified input criteria. Each document contains information about the signature item. The document’s key will be the same as the signature item’s name. For a description of what information is supplied by your database, see java.sql.DatabaseMetaData.getProcedureColumns in your JDBC documentation.

pub.db:getProcsWmDB. Retrieves the names of stored procedures for the specified database. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters


$dbAlias

–OR–


–OR–

$dbConnection







$dbCatalog String Optional. Name of the database’s system catalog. Include this parameter if your DBMS supports distributed databases and you want to retrieve a list of stored procedures from a database other than the one to which you are connected.




pub.db:getTableInfo

Output Parameters

This service returns one document (IData object) for each stored procedure that matches the specified input criteria. Each document contains information about a stored procedure. The document’s key will be the same as the stored procedure name. For a description of what information is supplied by your database, see java.sql.DatabaseMetaData.getProcedures in your JDBC documentation.

pub.db:getTableInfoWmDB. Retrieves information about columns in the specified table. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters

$dbSchemaPattern String Optional. Name of the schema to which the stored procedures belong.


If you are running against DB2, you use this parameter to specify the database’s AuthID.

$dbProcNamePattern String Optional. Pattern-matching string that specifies the procedures that you want included in the returned list, where _ represents a single character and % represents any string of characters. For example, the value DATE% would represent any procedure beginning with the characters DATE.


$dbAlias

–OR–


–OR–

$dbConnection








Output Parameters

This service returns one document (IData object) for each column that matches the specified input criteria. Each document contains information about a column. The document’s key will be the same as the column name.

Usage Notes

This service accepts input from a Web browser or HTML form.


$dbCatalog String Optional. Name of the database’s system catalog. Include this parameter if your DBMS supports distributed databases and you want information about a table that is not in the database to which you are connected.

If you are not using a distributed database system or you want information about a table in the database to which you are connected, you do not need to specify this parameter.



If your database supports pattern-matching on schemas, you may specify a pattern-matching string for the schema name, where _ represents a single character and % represents any string of characters. For example, the value HR% would represent any schema beginning with the characters HR.


$dbTable String Name of table whose column names you want to retrieve.

$dbColumnNamePattern String Optional. Pattern-matching string that specifies the column names that you want to retrieve, where _ represents a single character and % represents any string of characters. For example, the value ADDR% would represent any column name beginning with the characters ADDR.


pub.db:getTables

pub.db:getTablesWmDB. Retrieves the names of tables in the specified database and schema. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters


$dbAlias

–OR–


–OR–

$dbConnection







$dbCatalog String Optional. Name of the database’s system catalog. Include this parameter if your DBMS supports distributed databases and you want information from a database that is not the one to which you are connected.

If you are not using a distributed database system or you want information about the database to which you are connected, you do not need to specify this parameter.


$dbSchemaPattern String Optional. Name of the schema for which you want the names of tables.

If your database supports pattern-matching on schemas, you may specify a pattern-matching string for the schema name, where _ represents a single character and % represents any string of characters. For example, the value HR% would represent any schema beginning with the characters HR.

If you want the table names from all schemas, set $dbSchemaPattern to null.




Output Parameters

This service returns one document (IData object) for each table that matches the specified input criteria. Each document contains information about a table. The document’s key will be the same as the table name.

Usage Notes


pub.db: insertWmDB. Inserts one or more rows into the specified table. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters

$dbTableNamePattern String Optional. Pattern string describing the tables whose names you want to retrieve.

If your database supports pattern-matching on schemas, you may specify a pattern-matching string, where _ represents a single character and % represents any string of characters. For example, the value HR% would represent any table name beginning with the characters HR.

If you want all table names, set $dbTableNamePattern to null.

$dbTableTypeList String List Optional. Set of parameters specifying the types of tables whose names you want to retrieve. Common JDBC table types include: TABLE, VIEW, SYSTEM TABLE, ALIAS, and SYNONYM. Check your driver documentation for others.


$dbAlias

–OR–


–OR–

$dbConnection






pub.db:insert

Output Parameters

Usage Notes




$dbCatalog String Optional. Name of the database’s system catalog. Include this parameter if your DBMS supports distributed databases and you want to insert rows into a table that is not in the database to which you are connected.

If you are not using a distributed database system or if you want to insert rows into the database to which you are connected, you do not need to specify this parameter.





$dbTable String Name of table in which you want to insert rows.

$dbRollbackOnFail String Optional. Flag that determine whether changes are committed if a failure occurs while processing multiple inserts.

Set to... To...

true Undo changes on failure.

false Default. Commit changes on failure.

$data Document or Document List Optional. Data to insert.

$updateCount String Number of rows the service inserted.

$failCount String Number of rows the service failed to insert.

$errors Document Conditional. Error messages generated during service execution.




pub.db:queryWmDB. Retrieves all rows from the specified table that meet the given criteria. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters


$dbAlias

–OR–


–OR–

$dbConnection







$dbCatalog String Optional. Name of the database’s system catalog. Include this parameter if your DBMS supports distributed databases and you want to query a table that is not in the database to which you are connected.

If you are not using a distributed database system or if you want to query a table in the database to which you are connected, you do not need to specify this parameter.





$dbTable String Name of table to query.


pub.db:rollback

Output Parameters

Usage Notes


pub.db:rol lbackWmDB. Discards changes to a database. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters

$data Document Optional. Criteria that the rows to retrieve must meet.

results com.wm.util.Table Conditional. Results of the query. The Integration Server recognizes and treats this parameter as a Document List at run time.

$dbMessage String Conditional. Message indicating the success or failure of an operation.

$rowCount String Conditional. Number of rows for the table that meet the criteria specified in $data.


$dbAlias

–OR–


–OR–

$dbConnection

$dbAlias String Optional. Alias of the database for which you want to discard changes. This information is passed automatically.








Output Parameters

Usage Notes

This service throws an exception if an error occurs when discarding changes to the database. The most common reason for this error is that no transaction has been started (see pub.db:startTransaction).

pub.db:startTransact ionWmDB. Begins a transaction on a database connection. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters

Output Parameters

Usage Notes

By default, all database connections are opened in “auto commit” mode, meaning the results of a operation are automatically committed to the database when that operation succeeds. To use a



$dbAlias

–OR–


–OR–

$dbConnection

$dbAlias String Optional. Alias of the database for which you want to start the transaction. This information is passed automatically.








pub.db:update

connection in a transactional context, you must first call pub.db:startTransaction to take that connection out of “auto commit” mode.

This service returns an exception if an error occurs when starting the new transaction. Common reasons for an error when starting a new transaction are:

A transaction is already in progress (see pub.db:commit, pub.db:rollback, or pub.db:clearTransaction).

The target database does not support transactions.

After a transaction has been started, it must be terminated with a call to either pub.db:commit (to save all changes to the database) or pub.db:rollback (to discard changes).

pub.db:updateWmDB. Updates all rows in a table that meet the given criteria. Rows are updated with the supplied new data. As an alternative to this service, consider using the services provided with the webMethods JDBC adapter.

Input Parameters


$dbAlias

–OR–


–OR–

$dbConnection









Output Parameters

$dbCatalog String Optional. Name of the database’s system catalog. Include this parameter if your DBMS supports distributed databases and you want to update rows in a table that is not in the database to which you are connected.

If you are not using a distributed database system or if you want to update rows in the database to which you are connected, you do not need to specify this parameter.

If you are running against DB2, you use this parameter to specify the database location.




$dbTable String Name of table to update.

$criteria Document Criteria that the rows to update must meet.

Important! If no criteria are provided, all rows are updated.

$set Document New data with which to update rows.

$updateCount String Number of rows updated.

$dbMessage String Conditional. Message indicating the operation failed.


C H A P T E R6
Document Folder
You use the elements in the document folder to perform operations on documents in the pipeline.


C H A P T E R 6 D o c u m e n t F o l d e r


pub.document:documentListToDocumentWmPublic. Constructs a document (an IData object) from a document list (an IData[ ]) by generating key/value pairs from the values of two elements that you specify in the document list.

The following illustrates how documentListToDocument would convert a document list that contains three documents to a single document containing three key/value pairs. When you use documentListToDocument, you specify which two elements from the source list are to be transformed into the keys and values in the output document. In this example, the values from the pName elements in the source list are transformed into key names, and the values from the pValue elements are transformed into the values for these keys.


pub.document:documentListToDocument WmPublic. Constructs a document (an IData object) from a document list (an IData[ ]) by generating key/value pairs from the values of two elements that you specify in the document list.

pub.document:documentToDocumentList WmPublic. Expands the contents of a document into a list of documents.

pub.document:documentToXMLValues WmPublic. Converts a document (IData object) to a String by encoding it in webMethods XMLValues format.

pub.document:XMLValuesToDocument WmPublic. Decodes a String containing an XMLValues-encoded document and produces a document (IData object).


pub.document:documentToDocumentList

Input Parameters

Output Parameters

pub.document:documentToDocumentListWmPublic. Expands the contents of a document into a list of documents.

Each key/value pair in the source document is transformed to a single document containing two keys (whose names you specify). These two keys will contain the key name and value of the original pair.

The following shows how a document containing three keys would be converted to a document list containing three documents. In this example, the names pName and pValue were specified as names for the two new keys in the document list.

A document List containing these 3 documents... Would be converted to a document containing these 3 keys...

Key Value Key Value

pName cx_timeout cx_timeout 1000

pValue 1000 cx_max 2500

cx_min 10

pName cx_max

pValue 2500

pName cx_min

pValue 10

documentList Document List Set of documents (IData[ ]) that you want to transform into a single document (IData object).

Note: If documentList contains a single document instead of a Document List, documentListToDocument does nothing.

name String Name of the element in documentList whose value provides the name of each key in the resulting document.

Important! The data type of the element that you specify in name must be String.

value String Name of the element in documentList whose values will be assigned to the keys specified in name. This element can be of any data type.

document Document Document (IData object) containing the key/value pairs generated from documentList.



Input Parameters

Output Parameters

pub.document:documentToXMLValuesWmPublic. Converts a document (IData object) to a String by encoding it in webMethods XMLValues format.

To convert the encoded String back into an IData object, use pub.document:XMLValuesToDocument.

Input Parameters

A document containing these 3 keys... Would be converted to a document list containing these 3 documents...

Key Value Key Value

cx_timeout 1000 pName cx_timeout

cx_max 2500 pValue 1000

cx_min 10

pName cx_max

pValue 2500

pName cx_min

pValue 10

document Document Document (IData object) to transform.

name String Name to assign to the key that will receive the key name from the original key/value pair (in the example above, this parameter was set to pName).

value String Name to assign to the key that will receive the value from the original key/value pair (in the example above, this parameter was set to pValue).

documentList Document List List containing a document for each key/value pair in document. Each document in the list will contain two keys, whose names were specified by name and value. The values of these two keys will be the name and value (respectively) of the original pair.

document Document Document (IData object) to convert. This document can contain any number of other fields, lists, and other documents.


pub.document:XMLValuesToDocument

Output Parameters

pub.document:XMLValuesToDocumentWmPublic. Decodes a String containing an XMLValues-encoded document and produces a document (IData object).

An XMLValues-encoded document is produced using pub.document:documentToXMLValues.

Input Parameters

Output Parameters

xmlvalues String String representation of document, encoded in webMethods XMLValues format.

xmlvalues String An XMLValues encoding of a document.

Important! This String must contain a webMethods XMLValues encoding of a document. No other encoding format is accepted.

document Document Document (IData object) result of the decoding of xmlvalues.


C H A P T E R7
Event Folder
You use the elements in the event folder to write your own event handler services. webMethods provides the pub.event.audit:logToFile and pub.event.exception:logToFile services as samples of audit and exception events and for backward compatibility with earlier versions of the webMethods Integration Server.


C H A P T E R 7 E v e n t F o l d e r



pub.event:addSubscriber WmPublic. Creates a subscription for a specified event.

pub.event:alarm WmPublic. Specification for alarm event handlers.

pub.event:alarmInfo WmPublic. Document type for alarm event information.

pub.event:audit WmPublic. Specification for audit event handlers.

pub.event:auditInfo WmPublic. Document type for audit event information.

pub.event:callStackItem WmPublic. Document type for the name of the service in the invocation path when an exception occurred.

pub.event:deleteSubscriber WmPublic. Removes an event handler from the subscription list for a specified event.

pub.event:exception WmPublic. Specification for exception event handlers.

pub.event:exceptionInfo WmPublic. Document type for exception information.

pub.event:gdEnd WmPublic. Specification for gdEnd event handlers.

pub.event:gdEndInfo WmPublic. Document type for gdEnd event information.

pub.event:gdStart WmPublic. Specification for gdStart event handlers.

pub.event:gdStartInfo WmPublic. Document type for gdStart event information.

pub.event:getEventTypes WmPublic. Returns the list of supported event types.

pub.event:getSubscribers WmPublic. Returns the list of subscribers for a specified event type.

pub.event:modifySubscriber WmPublic. Modifies the information about a subscription.

pub.event:portStatus WmPublic. Specification for a port status event.

pub.event:portStatusInfo WmPublic. Document type for port event information.

pub.event:reloadEventManagerSettings WmPublic. Reloads the settings from the event manager’s configuration file (eventcfg.bin) on the server.

pub.event:replication WmPublic. Specification for replication event handlers.

pub.event:replicationInfo WmPublic. Document type for replication event information.

pub.event:saveEventManagerSettings WmPublic. Saves the current subscriber information to the event manager’s configuration file (eventcfg.bin) on the server.

pub.event:sessionEnd WmPublic. Specification for sessionEnd event handlers.

pub.event:sessionEndInfo WmPublic. Document type for sessionEnd event information.


pub.event:addSubscriber

pub.event:addSubscriberWmPublic. Creates a subscription for a specified event.

Important! Subscriptions that you add using this service take effect immediately; however, they are not made permanent unless you also persist them to disk with the pub.event:saveEventManagerSettings service. If you do not run pub.event:saveEventManagerSettings after adding subscribers, your changes will be lost when the server is restarted.

pub.event:sessionExpire WmPublic. Specification for sessionExpire event handlers.

pub.event:sessionExpireInfo WmPublic. Document type for sessionExpire event information.

pub.event:sessionStart WmPublic. Specification for sessionStart event handlers.

pub.event:sessionStartInfo WmPublic. Document type for sessionStart event information.

pub.event:stat WmPublic. Specification for stat event handlers.

pub.event:statInfo WmPublic. Document type for stat event information.

pub.event:txEnd WmPublic. Specification for txEnd event handlers.

pub.event:txEndInfo WmPublic. Document type for txEnd event information.

pub.event:txStart WmPublic. Specification for txStart event handlers.

pub.event:txStartInfo WmPublic. Document type for txStart event information.

pub.event.audit:logToFile WmPublic. Deprecated—Logs audit events to the audit log.

pub.event.exception:logToFile WmPublic. Deprecated—Logs exception events to the error log.




Input Parameters

EventType String Type of event to which the event handler is subscribing. Must be one of the following:

Alarm EventAudit EventException EventGD End EventGD Start EventPort Status EventReplication EventSession End EventSession Expire EventSession Start EventStat EventTx End EventTx Start Event

Tip! To view the current list of event types, you can execute the pub.event:getEventTypes service in Developer.

Filter String Selects (filters) the set of events within EventType to which the event handler is subscribing. addSubscriber uses Filter as a pattern string to filter a particular attribute of an event.

The pattern string can be composed of literal characters, which match a character exactly, and/or the “*” character, which matches any sequence of characters. For example:

This pattern string... Would match...

* Any string

M* Any string that starts with an uppercase “M.”

M*X Any string that starts with an uppercase “M” and ends with an uppercase “X.”

The following table shows the attribute that is filtered for each event type. Note that some event types cannot be filtered.

EventType Filtered attribute

Alarm Event Message generated by the alarm event.

Audit Event Fully qualified name of the service that generates the audit event.

Exception Event

Fully qualified name of the service that generates the exception event.

GD End Event None. This event type cannot be filtered. Filter is ignored for this event type.


pub.event:addSubscriber

GD Start Event Fully qualified name of the service that generates the GD Start Event.

Port Status Event

None. This event type cannot be filtered. Filter is ignored for this event type.

Replication Event

Name of the package being replicated.

Session End Event


Session Expire Event


Session Start Event

User ID of the user starting the session or the groups to which the user belongs. (The filter is applied to a space-delimited list of groups, composed of group names suffixed with the user’s user ID.)

The following examples show how you might filter session start events for various groups and/or user IDs:

To select session starts for any user in the Administrators group, the filter would be:

*Administrators*

To select session starts for the user ID “LRMalley” in the Administrators group, the filter would be:

*Administrators*LRMalley

To select session starts for the user ID “LRMalley” in any group, the filter would be:

*LRMalley

Stat Event None. This event type cannot be filtered. Filter is ignored for this event type.

Tx End Event None. This event type cannot be filtered. Filter is ignored for this event type.

Tx Start Event None. This event type cannot be filtered. Filter is ignored for this event type.

Service String Fully qualified name of the event-handler service (the service that will execute when the event specified by EventType and Filter occurs).

Comment String Descriptive comment for this subscription. This comment is displayed when subscriptions are viewed with Developer.

Enabled String Flag specifying the status of the subscription. Must be one of the following values:



Output Parameters

See Also

pub.event:deleteSubscriberpub.event:modifySubscriberpub.event:getSubscriberspub.event:saveEventManagerSettings

pub.event:alarmWmPublic. Specification for alarm event handlers.

Input Parameters

Output Parameters

None.

Usage Notes

Remember to register your handler with the Event Manager.

Set to... To...

true Make the subscription active.

false Default. Make the subscription inactive.

Note: Although the default value is false, you will generally want to set Enabled to true to activate the subscription immediately when it is added.

Result String Flag indicating whether the subscriber was successfully added.


true The subscriber was added successfully.

false The subscriber was not added.

time String Date and time that the event occurred, in the format yyyy/MM/dd HH:mm:ss.SS.

service String Fully qualified name of the service that generated the event.

sessionID String Session ID of the service firing the alarm.

msg String Text describing the alarm.


pub.event:alarmInfo

pub.event:alarmInfoWmPublic. Document type for alarm event information.

Parameters

pub.event:auditWmPublic. Specification for audit event handlers.

Input Parameters

Output Parameters

None.




msg String Text describing the alarm.


TID String Transaction ID of the service that generated the event.


sessionID String Session ID of the service that generated the event.

result String Description of the audit point.


begin This event marks the beginning of a service.

ok This event marks the end of a service that executed successfully.

errorInfo This event marks the end of a service that executed unsuccessfully (that is, threw an exception). This string will start with the characters “error” and be followed by additional text containing specific error information about the exception.

pipeline Document Optional. State of the pipeline at the audit point.

userName String User ID that invoked the service that generated the event.



Usage Notes

Remember to register your handler with the Event Manager. Not all audit handlers that you code will log information.

When writing your own audit handler, be careful to not modify the pipeline variable within your handler.

pub.event:audit InfoWmPublic. Document type for audit event information.

Parameters

pub.event:cal lStackItemWmPublic. Document type for the name of the service in the invocation path when an exception occurred.

Parameters





result String Description of the audit point.


begin This event marks the beginning of a service.

ok This event marks the end of a service that executed successfully.

errorInfo This event marks the end of a service that executed unsuccessfully (that is, threw an exception). This string will start with the characters “error” and be followed by additional text containing specific error information about the exception.



service String Fully qualified name of the last service (that is, most recently called) on the call stack.


pub.event:deleteSubscriber

pub.event:deleteSubscriberWmPublic. Removes an event handler from the subscription list for a specified event.

Important! Deletions made using this service take effect immediately; however, they are not made permanent unless you persist them to disk with the pub.event:saveEventManagerSettings service. If you do not run pub.event:saveEventManagerSettings after deleting subscribers, your changes will be lost when the server is restarted.

Input Parameters

Output Parameters

See Also

pub.event:addSubscriberpub.event:modifySubscriberpub.event:getSubscriberspub.event:saveEventManagerSettings

EventType String Type of event from which the event handler is unsubscribing. Must be one of the following values:



gID String ID of the subscriber that you want to delete. To get a list of subscriber IDs, execute the pub.event:getSubscribers service.

Result String Flag indicating whether the subscriber was successfully deleted.


true The subscriber was deleted successfully.

false The subscriber was not deleted (typically an invalid subscriber ID was provided in gID).



pub.event:except ionWmPublic. Specification for exception event handlers.

Input Parameters

Output Parameters

None.

Usage Notes

Not all exception handlers that you code will log information.


error String Optional. Error message of the exception.

localizedError String Optional. Error message in the language that corresponds to the locale of your webMethods installation.

errorType String Exception type that was thrown.

errorDump String More detailed information about the exception.

service String Optional. Fully qualified name of the service that generated the event.

user String User that requested the service that generated the event.

callStack Document List Optional. A document list containing information about the services on the callstack when the exception occurred. The structure of the documents in this list is defined by pub.event:callStackItem.

pipeline Document Optional. State of the pipeline at the time the exception occurred.

threadID String Thread ID identifying the thread that invoked the service.

ssnid String Session ID during which the exception occurred.

errorMsgID String Optional. The identification number for the error message.

errorDetails Document Optional. Additional exception information provided by the author of the Java service. For more information about constructing exceptions to return additional information, see the webMethods Integration Server Java API Reference for the com.wm.util.LocalizedException class.

nestedErrorInfo Document Optional. Nested errors and exceptions, if any. The structure of this document is defined by pub.event:exceptionInfo.


pub.event:exceptionInfo

pub.event:except ionInfoWmPublic. Document type for exception information.

Parameters

pub.event:gdEndWmPublic. Specification for gdEnd event handlers.

Input Parameters


error String Optional. Error message of the exception.

localizedError String Optional. Error message in the language that corresponds to the locale of your webMethods installation.



service String Optional. Fully qualified name of the service that generated the event.


callStack Document List Optional. The callstack when the exception occurred. Each document represents a service on the callstack. The structure of this document is defined by pub.event:callStackItem.

pipeline Document Optional. State of the pipeline at the time the exception occurred.

threadID String Thread ID identifying the thread that invoked the service.


errorMsgID String Optional. The identification number for the error message.

errorDetails Document Optional. Additional exception information provided by the author of the Java service. For more information about constructing exceptions to return additional information, see the webMethods Integration Server Java API Reference for the com.wm.util.LocalizedException class.

nestedErrorInfo Document Optional. Nested errors and exceptions, if any. The structure of this document is defined by pub.event:exceptionInfo.





Output Parameters

None.

pub.event:gdEndInfoWmPublic. Document type for gdEnd event information.

Parameters

pub.event:gdStartWmPublic. Specification for gdStart event handlers.

Input Parameters

Output Parameters

None.

Usage Notes


result String Status of the transaction.






svcname String Fully qualified name of the service that generated the event.



pub.event:gdStartInfo

pub.event:gdStart InfoWmPublic. Document type for gdStart event information.

Parameters

pub.event:getEventTypesWmPublic. Returns the list of supported event types.

Input Parameters

None.

Output Parameters



svcname String Fully qualified name of the service that generated the event.


EventTypes Document The types of events that the server supports:Alarm EventAudit EventException EventGD End EventGD Start EventPort Status EventReplication EventSession End EventSession Expire EventSession Start EventStat EventTx End EventTx Start Event



pub.event:getSubscribersWmPublic. Returns the list of subscribers for a specified event type.

Input Parameters

Output Parameters

EventType String Type of event for which you want the list of subscribers. Must be one of the following values:



Subscribers Document The list of subscribers. For each subscriber, Subscribers will contain a key that is the subscriber ID. The value of that key is a document containing the following information about the subscriber:

Key Description

Service String Fully qualified name of the event-handler service (that is, the service that subscribes to the event in EventType).

Filter String Filter associated with the subscription. This is a pattern string that selects (filters) an event based on a particular attribute. Filter is composed of literal characters, which match a character exactly, and/or the “*” character, which matches any sequence of characters. For example:

This string... Would match...

* Any string




pub.event:modifySubscriber

See Also

pub.event:addSubscriberpub.event:modifySubscriberpub.event:deleteSubscriber

pub.event:modifySubscriberWmPublic. Modifies the information about a subscription.

Important! The changes you make with this service take effect immediately; however, they are not made permanent unless you also persist them to disk with the pub.event:saveEventManagerSettings service. If you do not run pub.event:saveEventManagerSettings after modifying subscribers, your changes will be lost when the server is restarted.

For a list of attributes to which the filter is applied, see pub.event:addSubscriber.

Comment String Descriptive comment associated with the description. If a comment has not been assigned to the subscription, Comment will be empty.

gID String Subscriber ID.

Enabled String Flag indicating the status of the subscription. Will be one of the following values:

Key Description

true Subscription is active.

false Subscription is inactive.



Input Parameters

EventType String Event type that you want the subscription to have:Alarm EventAudit EventException EventGD End EventGD Start EventPort Status EventReplication EventSession End EventSession Expire EventSession Start EventStat EventTx End EventTx Start Event


gID String ID of the subscriber that you want to modify. To get the current list of subscriber IDs, execute thepub.event:getSubscribers service.

Filter String Filter that you want subscription to have. Filter is a pattern-matching string composed of literal characters, which match a character exactly, and/or the “*” character, which matches any sequence of characters. For example:

This pattern string... Would match...

* Any string



The following table shows the attribute that is filtered for each event type. Note that some event types cannot be filtered.

EventType Filtered attribute

Alarm Event Message generated by the alarm event.

Audit Event Fully qualified name of the service that generates the audit event.

Exception Event Fully qualified name of the service that generates the exception event.

GD End Event None. This event type cannot be filtered. Filter is ignored for this event type.


pub.event:modifySubscriber

GD Start Event Fully qualified name of the service that generates the GD Start Event.

Port Status Event None. This event type cannot be filtered. Filter is ignored for this event type.

Replication Event Name of the package being replicated.

Session End Event None. This event type cannot be filtered. Filter is ignored for this event type.

Session Expire Event None. This event type cannot be filtered. Filter is ignored for this event type.

Session Start Event User ID of the user starting the session or the groups to which the user belongs. (The filter is applied to a space delimited list of groups, composed of group names suffixed with the user’s user ID.)

The following examples show how you might filter session-start events for various groups and/or user IDs:

To select session starts for any user in the Administrators group, the filter would be:

*Administrators*

To select session starts for the user ID “LRMalley” in the Administrators group, the filter would be:

*Administrators*LRMalley

To select session starts for the user ID “LRMalley” in any group, the filter would be:

*LRMalley

Stat Event None. This event type cannot be filtered. Filter is ignored for this event type.

Tx End Event None. This event type cannot be filtered. Filter is ignored for this event type.

Tx Start Event None. This event type cannot be filtered. Filter is ignored for this event type.

Service String Fully qualified name of the event-handler service that you want the subscription to specify.

Comment String Descriptive comment that you want to assign to the subscription.

Enabled String Flag specifying the status of the subscription. Must be one of the following values:



Output Parameters

See Also

pub.event:addSubscriberpub.event:deleteSubscriberpub.event:getSubscriberspub.event:saveEventManagerSettings

pub.event:portStatusWmPublic. Specification for a port status event.

Input Parameters

Set to... To...

true Make the subscription active.

false Default. Make the subscription inactive.

Note: Although the default value is false, you will generally want to set Enabled to true to activate the subscription immediately after it is modified.

Result String Flag indicating whether the subscriber was successfully modified.


true The subscriber was updated successfully.

false The subscriber was not updated (typically because an invalid subscriber ID was provided in gID).

portStatusInfo Document List List of documents (Data[ ] objects) containing the following information for each port.

Key Description


port String Number for the port.

status String Status of the port.

protocol String Type of port (for example, http, https, ftp, or email).

primary String Primary port. By default, the webMethods Integration Server designates an HTTP port at port 5555 as the primary port.

enabled String Flag indicating whether or not the port is enabled.


pub.event:portStatusInfo

Output Parameters

None.

pub.event:portStatusInfoWmPublic. Document type for port event information.

Parameters

pub.event:reloadEventManagerSett ingsWmPublic. Reloads the settings from the event manager’s configuration file (eventcfg.bin) on the server.

Input Parameters

None.

Output Parameters

None.

Set to... To indicate that...

true The port is enabled.

false The port is disabled.


port String Number for the port.

status String Status of the port.

protocol String Type of port (for example, http, https, ftp, or email).

primary String The primary port. By default, the webMethods Integration Server designates an HTTP port at port 5555 as the primary port.

enabled String A flag indicating whether or not the port is enabled.


true The port is enabled.

false The port is disabled.



See Also

pub.event:saveEventManagerSettings

pub.event:repl icat ionWmPublic. Specification for replication event handlers.

Input Parameters

Output Parameters

None.

Usage Notes

Remember to register your handler with the Event Manager. When you subscribe an event handler to a replication event, you can create a filter to specify the package that, when replicated, will invoke the event handler.

pub.event:repl icat ionInfoWmPublic. Document type for replication event information.

Parameters


action String Description of the event (such as create or push). The value of action can be used to maintain separate logs for each action type.

package String Name of package being replicated.



action String Description of the event (such as create or push). The value of action can be used to maintain separate logs for each action type.

package String Name of package being replicated.



pub.event:saveEventManagerSettings

pub.event:saveEventManagerSett ingsWmPublic. Saves the current subscriber information to the event manager’s configuration file (eventcfg.bin) on the server.

Important! Always run this service after making any permanent changes to subscriber information (for example, add subscribers, modify subscribers, or delete subscribers). Otherwise, your changes will be lost the next time the server is restarted.

Input Parameters

None.

Output Parameters

None.

See Also

pub.event:addSubscriberpub.event:deleteSubscriberpub.event:modifySubscriberpub.event:reloadEventManagerSettings

pub.event:sessionEndWmPublic. Specification for sessionEnd event handlers.

Input Parameters

Output Parameters

None.

Usage Notes




rpcs String Number of service calls the session has performed.

age String Number of milliseconds the session existed before it ended.



pub.event:sessionEndInfoWmPublic. Document type for sessionEnd event information.

Parameters

pub.event:sessionExpireWmPublic. Specification for sessionExpire event handlers.

Input Parameters

Output Parameters

None.

Usage Notes


pub.event:sessionExpireInfoWmPublic. Document type for sessionExpire event information.

Parameters

time String Date and time that the event occurred. Given in the format yyyy/MM/dd HH:mm:ss.SS.



age String Number of milliseconds the session existed before it ended.




age String Number of milliseconds the session existed before it expired.




pub.event:sessionStart

pub.event:sessionStartWmPublic. Specification for sessionStart event handlers.

Input Parameters

Output Parameters

None.

Usage Notes

Remember to register your handler with the Event Manager. When you subscribe an event handler to a Session Start event, you can create a filter so that only session start events generated by a specific user or by a member of a specific group invoke the event handler.

pub.event:sessionStart InfoWmPublic. Document type for sessionStart event information.

Parameters


age String Number of milliseconds the session existed before it expired.


sessionID String ID of the new session.

userid String User ID that the IS client or developer used to log on to the webMethods Integration Server.

sessionName String Name of the new session.


sessionID String ID of the new session.

userid String User ID that the IS client or developer used to log on to the webMethods Integration Server.

sessionName String Name of the new session.



pub.event:statWmPublic. Specification for stat event handlers.

Input Parameters

startTime String Date and time that the event occurred. Given in the format yyyy/MM/dd HH:mm:ss.SS.

uptime String Amount of time the server has been up. Given in the format yyyy/MM/dd HH:mm:ss.SS.

totalMem String Total amount of used and unused storage available to the JVM, in kilobytes. For example, a value of 65535 represents 64 megabytes of storage.

freeMem String Amount of unused storage available to the Integration Server, in kilobytes. For example, a value of 65535 represents 64 megabytes of storage.

usedMem String Amount of storage used by the Integration Server, in kilobytes. For example, a value of 65535 represents 64 megabytes of storage.

freeMemPer String Percent of total memory unused.

usedMemPer String Percent of total memory used.

svrT String Number of services currently running.

svrTMax String Peak number of servers ever running concurrently.

sysT String Number of JVM threads running.

sysTMax String Peak number of threads ever running.

conn String Number of current sessions.

connMax String Peak number of concurrent sessions.

reqTotal String Cumulative total number of services processed.

reqAvg String Average duration of service.

newReqPM String New requests per minute.

endReqPM String End requests per minute.

errSvc String Number of services completed in error state.

svcRate String Number of end/start(s) per second.

ssnUsed String Number of licensed sessions currently active.

ssnPeak String Number of licensed sessions that have ever run concurrently on the server.

ssnMax String Maximum number of sessions for which the server is licensed.

errSys String Number of unknown errors.


pub.event:statInfo

Output Parameters

None.

Usage Notes


pub.event:stat InfoWmPublic. Document type for stat event information.

Parameters

startTime String Date and time that the event occurred. Given in the format yyyy/MM/dd HH:mm:ss.SS.

uptime String Amount of time the server has been up. Given in the format yyyy/MM/dd HH:mm:ss.SS.

totalMem String Total amount of used and unused storage available to the JVM, in kilobytes. For example, a value of 65535 represents 64 megabytes of storage.

freeMem String Amount of unused storage available to the Integration Server, in kilobytes. For example, a value of 65535 represents 64 megabytes of storage.

usedMem String Amount of storage used by the Integration Server, in kilobytes. For example, a value of 65535 represents 64 megabytes of storage.

freeMemPer String Percent of total memory unused.

usedMemPer String Percent of total memory used.

svrT String Number of services currently running.

svrTMax String Peak number of servers ever running concurrently.

sysT String Number of JVM threads running.

sysTMax String Peak number of threads ever running.

conn String Number of current sessions.

connMax String Peak number of concurrent sessions.

reqTotal String Cumulative total number of services processed.

reqAvg String Average duration of service.

newReqPM String New requests per minute.

endReqPM String End requests per minute.

errSvc String Number of services completed in error state.

svcRate String Number of end/start(s) per second.



pub.event: txEndWmPublic. Specification for txEnd event handlers.

Input Parameters

Output Parameters

None.

Usage Notes


pub.event: txEndInfoWmPublic. Document type for txEnd event information.

Parameters

ssnUsed String Number of licensed sessions currently active.

ssnPeak String Number of licensed sessions that have ever run concurrently on the server.

ssnMax String Maximum number of sessions for which the server is licensed.

errSys String Number of unknown errors.








pub.event:txStart

pub.event: txStartWmPublic. Specification for txStart event handlers.

Input Parameters

Output Parameters

None.

Usage Notes


pub.event: txStart InfoWmPublic. Document type for txStart event information.

Parameters

pub.event .audit : logToFi leWmPublic. Deprecated—Logs audit events to the audit log.

Input Parameters













Output Parameters

None.

Usage Notes

When writing your own audit handler, be careful to not modify the pipeline variable within your handler.

pub.event .except ion: logToFi leWmPublic. Deprecated—Logs exception events to the error log.

This service will also send an email notice if your SMTP settings are configured properly.

Input Parameters

Output Parameters

None.

result String Description of the audit point (“begin”, “ok”, “error”, …).




error String Error message of the exception.





callStack Document List Optional. A document list containing information about the services on the callstack when the exception occurred. The structure of the documents in this list is defined by pub.event:callStackItem.

pipeline Document State of the pipeline at the time the exception occurred.

threadID String The thread ID identifying the thread that invoked the service.



C H A P T E R8
Fi le Folder
You use the elements in the file folder to perform operations on the local file system.


C H A P T E R 8 F i l e F o l d e r


pub.f i le:getFi leWmPublic. Retrieves a specified file from the local file system.

If the file contains an XML document, you can use the services in the XML Folder to convert it to an XML node.

Input Parameters

Output Parameters


pub.file:getFile WmPublic. Retrieves a specified file from the local file system.

filename String Complete path to the file in the local file system. For example: c:\rubicon\document.xml

loadAs String Optional. Form in which you want getFile to make the contents of the file available to subsequent services.

Set to... To...

bytes Default. Return the file as a byte array. Use this option if the contents of the file will be used as input to a service that operates on whole documents (for example, pub.xml:queryXMLNode).

stream Return the file as an input stream. Use this option if the contents of the file will be used as input to a service that can process a document incrementally (for example, Usage Notes).

bufferSize String Optional. Buffer size (in bytes) to use if you are loading an InputStream (that is, loadAs=stream). The default is 4096 bytes. For example: 1024

body Document Document (IData object) containing the file as a byte[ ] or an InputStream. body will contain one of the following keys, depending on how loadAs was set:

Key Description

bytes byte[ ] Conditional. File contents in a byte array (if loadAs is set to bytes.)

stream java.io.InputStream Conditional. File contents as an InputStream (if loadAs is set to stream).


pub.file:getFile

Usage Notes

getFile does not automatically generate an XML node from the contents of the file. To generate an XML node, pass the output from this service to pub.xml:xmlStringToXMLNode.


C H A P T E R 8 F i l e F o l d e r


C H A P T E R9
Flow Folder
You use the elements in the flow folder to perform debugging and utility-type tasks in a flow service.


C H A P T E R 9 F l o w F o l d e r



pub.flow:clearPipeline WmPublic. Removes all fields from the pipeline. You may optionally specify fields that should not be cleared by this service.

pub.flow:debugLog WmPublic. Writes a message to the server log.

pub.flow:getLastError WmPublic. Obtains detailed information about the last exception that was trapped within a flow.

pub.flow:getRetryCount WmPublic. Retrieves the retry count for a trigger service.

pub.flow:getSession WmPublic. Retrieves information about the protocol from which the current service was invoked.

pub.flow:getTransportInfo WmPublic. Retrieves information about the protocol from which the current service was invoked.

pub.flow:restorePipeline WmPublic. Restores a pipeline previously saved by pub.flow:savePipeline.

pub.flow:restorePipelineFromFile WmPublic. Restores a pipeline that was previously saved to a file.

pub.flow:savePipeline WmPublic. Saves a pipeline into memory, for later retrieval with pub.flow:restorePipeline.

pub.flow:savePipelineToFile WmPublic. Saves the current pipeline to a file on the machine running webMethods Integration Server.

pub.flow:setResponse WmPublic. Forces a specified response string to be returned by the webMethods Integration Server to a calling process (such as a browser or application server).

pub.flow:throwExceptionForRetry WmPublic. Throws an ISRuntimeException and instructs the Integration Server to re-execute the trigger service using the same document as input.

pub.flow:tracePipeline WmPublic. Writes the names and values of all fields in the pipeline to the server log.

pub.flow:transportInfo WmPublic. Document type used to return information about the protocol through which a service was invoked.


pub.flow:clearPipeline

pub.f low:clearPipel ineWmPublic. Removes all fields from the pipeline. You may optionally specify fields that should not be cleared by this service.

Input Parameters

Output Parameters

None.

pub.f low:debugLogWmPublic. Writes a message to the server log.

Each log message contains a timestamp, a message ID, the function name field, and message field. The following is an example:

Input Parameters

Output Parameters

None.

pub.f low:getLastErrorWmPublic. Obtains detailed information about the last exception that was trapped within a flow.

An exception is trapped in a flow when a service failure occurs inside a SEQUENCE step that executes until DONE, or when a service failure occurs inside a REPEAT step that repeats on FAILURE.

preserve String List Optional. Field names that should not be cleared from the pipeline.

message String Optional. Text of the message to write to the log.

function String Optional. Function name, typically an abbreviation used to identify the source of the message.

level String Optional. Debug level at which to display this message. Defaults to 1. If the debug level on the server is set to a value less than this parameter, the message will not be written.

2002-08-16 11:01:23 EDT [PRT.0111.0003D] My function – My message

messagefunction



Input Parameters

None.

Output Parameters

Usage Notes

If this service is not invoked from within a flow service, an exception is thrown.

Each execution of a service (whether the service succeeds or fails) updates the value returned by getLastError. Consequently, getLastError itself resets the value of lastError. Therefore, if the results of getLastError will be used as input to subsequent services, map the value of lastError to a variable in the pipeline.

pub.f low:getRetryCountWmPublic. Retrieves the retry count for a trigger service.

The retry count indicates the number of times the Integration Server has re-executed a trigger service using the same document as input. For example, a retry count of 1 indicates the server tried to execute the service twice (the initial attempt and then one retry).

Input Parameters

None.

Output Parameters

Usage Notes

To retrieve a retry count, the pub.flow:getRetryCount service must be invoked within a trigger service.

The Integration Server retries a trigger service if the trigger service uses the pub.flow:throwISRuntimeException service to throw an ISRuntimeException. The Integration Server will also retry a trigger service written in Java if the service throws an exception using ISRuntimeException ( ). For more information about constructing ISRuntimeExceptions in Java services, see the webMethods Integration Server Java API Reference for the com.wm.app.b2b.server.ISRuntimeException class.

The maximum number of times the Integration Server retries a trigger service depends on the value of the Max attempts property for the trigger.

lastError Document Information about the last error, translated into the language used by the Integration Server. The structure of this document is defined by pub.event:exceptionInfo.

retryCount String The number of times the Integration Server has re-executed a trigger service to process the same document.


pub.flow:getSession

See Also

pub.flow:throwExceptionForRetry

pub.f low:getSessionWmPublic. Inserts the Session object into the pipeline as a document named $session.

Session is useful for associating values with particular clients or users. Once $session is added to the pipeline, it can be used like any other document in a flow. This permits more powerful flows that perform work spanning several user requests.

Input Parameters

None.

Output Parameters

pub.f low:getTransport InfoWmPublic. Retrieves information about the protocol from which the current service was invoked.

Input Parameters

None.

Output Parameters

Usage Notes

The value of the protocol key in transport indicates which protocol was used to invoked the service. For example, if the service was invoked via the email protocol, protocol would be set to email. transport will also contain a document (whose key is protocol-dependent) that holds protocol-specific details.

To use this service, first check the value of the protocol parameter to determine which protocol had been used. Then, depending on the value of protocol, extract the appropriate protocol information from transport. See pub.flow:transportInfo for the structure of the document that holds the protocol details.

$session Document Information for the current user session. Setting, copying, or dropping fields within $session is effectively manipulating the Session object on the server.

transport Document Information about the protocol that invoked the service. The structure of this document is defined by pub.flow:transportInfo.



pub.f low:restorePipel ineWmPublic. Restores a pipeline previously saved by pub.flow:savePipeline.

Input Parameters

Output Parameters

The output is dynamic, based on the contents of the saved and existing pipelines.

Usage Notes

After a successful invocation of restorePipeline, the pipeline will contain all fields that were present immediately before pub.flow:savePipeline was invoked. restorePipeline clears existing pipeline values unless the optional $merge field is specified.

This service is helpful in the interactive development or debugging of an application.

See Also

pub.flow:savePipelinepub.flow:restorePipelineFromFile

$name String Name of the saved pipeline. Because multiple pipelines can be saved, this parameter is necessary to identify the pipeline in memory. If this value is left null or the name is unknown, an exception will be thrown.

$merge String Optional. Flag that indicates whether or not to merge the values in the existing pipeline with the values in the saved pipeline.

Set to... To...

false Default. Clear the existing pipeline before restoring the saved pipeline.

true Merge the existing pipeline with the saved pipeline. If a field exists in the saved pipeline and the existing pipeline, the saved field takes precedence.

$remove String Optional. Flag that indicates whether or not the saved pipeline will remain in memory after this service is executed.

Set to... To...

false Default. Retain the saved pipeline in memory so that future calls to restorePipeline with the same $name will still return the saved pipeline.

true Remove the saved pipeline from memory after the service executes.


pub.flow:restorePipelineFromFile

pub.f low:restorePipel ineFromFileWmPublic. Restores a pipeline that was previously saved to a file.

Input Parameters

Output Parameters

The output is dynamic, based on the contents of the saved and existing pipelines.

Usage Notes


Be aware that variables that exist in the saved pipeline but are not defined in the flow will not appear on the Pipeline tab and, therefore, will not be available for explicit mapping.

See Also

pub.flow:savePipelineToFilepub.flow:restorePipeline

pub.f low:savePipel ineWmPublic. Saves a pipeline into memory, for later retrieval with pub.flow:restorePipeline.

Input Parameters

Output Parameters

None.

fileName String Relative path and file name of a file containing a saved pipeline on the Integration Server. If the file is not found at run time, an exception is thrown.

merge String Optional. Flag that determines whether or not to merge the saved values into the existing pipeline.

Set to... To...

false Default. Replace the existing pipeline with the saved values.

true Merge the saved values into the existing pipeline.

$name String Name that will identify the pipeline in memory. An exception will be thrown if this value is not specified.



Usage Notes

After a successful invocation of savePipeline, a snapshot of all pipeline fields will be saved in memory under the key provided by $name. Note that since the pipeline is saved to memory, it will not be available after a server restart.


See Also

pub.flow:restorePipelinepub.flow:savePipelineToFile

pub.f low:savePipel ineToFi leWmPublic. Saves the current pipeline to a file on the machine running webMethods Integration Server.

Input Parameters

Output Parameters

None.

Usage Notes


See Also

pub.flow:restorePipelineFromFilepub.flow:savePipeline

pub.f low:setResponseWmPublic. Forces a specified response string to be returned by the webMethods Integration Server to a calling process (such as a browser or application server).

Formatting of the response is normally handled by templates, which format values from the pipeline. If templates are not appropriate for a particular integration scenario, a response message can be created within the flow and then returned to the caller using this service.

Typical usage of this service is to create an XML response to an XML request. A flow that creates an XML document by calling pub.xml:documentToXMLString can use pub.flow:setResponse to return the XML document to the caller. In your flow, you would map xmldata (output of pub.xml:documentToXMLString) to response (input to

fileName String Relative path to a file on webMethods Integration Server in which to save the contents of the pipeline. If the file does not exist, the service creates it. If the file already exists, the service overwrites it.


pub.flow:throwExceptionForRetry

setResponse). Calling setResponse will cause the server to return the XML document that you’ve mapped to response instead of processing the pipeline through a template.

Input Parameters

Output Parameters

None.

Usage Notes

The webMethods Integration Server detects the type of request and sets the Content-Type value to text/XML (for requests in XML format) or text/HTML (for requests in all other formats). Be aware that if you specify a value for contentType, Developer will not be able to decode or display output from flows that include this service. This is because your contentType setting will override the Content-Type value that the Integration Server uses to return output to Developer. If you use Run to test the flow, Developer will not display any results. Instead, you will receive an error message. Therefore, if you include this service in a flow and you want to test the flow from Developer, use the Run in Browser command.

pub.f low:throwExceptionForRetryWmPublic. Throws an ISRuntimeException and instructs the Integration Server to re-execute the trigger service using the same document as input.

Input Parameters

response String Response to be returned to the caller.

contentType String Optional. MIME type of the response data. By default, the server’s response will match the MIME type of the request. This field allows this behavior to be overridden.

Note: If you explicitly set this value with Developer, you will see two choices: text/XML and text/HTML. You are not limited to these two values. You may either select one of these or type a new value.

encoding String Optional. Character set in which the response is encoded.

wrappedException Object Optional. Any exception that you want to include as part of this ISRuntimeException. This might be the exception that causes the pub.flow:throwExceptionForRetry service to execute. For example, if the trigger service attempts to connect to a database and the connection attempt fails, you might map the exception generated by the database connection failure to the wrappedException parameter.

message String Optional. A message to be logged as part of this exception.



Output Parameters

None.

Usage Notes

Use the pub.flow:throwExceptionForRetry service to handle transient errors that might occur during execution of a trigger service. A transient error is an error that arises from a condition that might be resolved quickly, such as the unavailability of a resource due to network issues or failure to connect to a database. The trigger service might execute successfully if the Integration Server waits and then retries the service. If a transient error occurs, the trigger service can catch this error and instruct the server to retry the trigger service by invoking pub.flow:throwExceptionForRetry.

You can invoke the pub.flow:getRetryCount service within a trigger service to determine the number of times the Integration Server retried a trigger service for a particular document.

If the trigger service is written in Java, the service can use ISRuntimeException ( ) to throw an exception and retry the service. For more information about constructing ISRuntimeExceptions in Java services, see the webMethods Integration Server Java API Reference for the com.wm.app.b2b.server.ISRuntimeException class.

For more information about how the Integration Server retries trigger services, see the Publish-Subscribe Developer’s Guide.

See Also

pub.flow:getRetryCount

pub.f low:tracePipel ineWmPublic. Writes the names and values of all fields in the pipeline to the server log.

Input Parameters

Output Parameters

None.

level String Optional. Debug level at which to write the pipeline. Defaults to 1. If the debug level on the webMethods Integration Server is set to a value less than this parameter, the pipeline will not be written to the server log.


pub.flow:transportInfo

pub.f low:transport InfoWmPublic. Document type used to return information about the protocol through which a service was invoked.

Parameters

protocol String Name of protocol about which transportInfo contains information. Will be one of the following values:


email The email protocol was used to invoke the service. Detailed information is contained in the email parameter.

http The http protocol was used to invoke the service. Detailed information is contained in the http parameter.

ftp The ftp protocol was used to invoke the service. Detailed information is contained in the ftp parameter.

filePolling The file polling protocol was used to invoke this service. Detailed information is contained in the filePolling parameter.

subprotocol String Conditional. HTTP subprotocol as follows:


HTTP The service was invoked through HTTP.

HTTPS The service was invoked through HTTPS.

This parameter is returned only when the service was invoked via HTTP.

email Document Conditional. Information about the email transport. Returned only if the email transport invoked the service.

Key Description

to String List Email addresses for the recipients of the email.

from String List Email addresses for the senders of the email.

cc String List Conditional. Email addresses receiving a copy of the email.

bcc String List Conditional. Email addresses receiving a blind copy of the email.

replyto String List Conditional. Email address to which replies of this email should be sent

subject String Subject of the email.

filename String Conditional. Name of the attached file.



contenttype String Conditional. Content-Type of the attached file.

content java.io.InputStream Conditional. Contents of the attached file.

recvdate String Conditional. Date the email was received in String format. recvdate may be passed as parameter for the java.util.Date constructor.

sentdate String Conditional. Date the email was sent in String format. sentdate may be passed as parameter for the java.util.Date constructor.

http Document Conditional. Information about the http transport. Returned only if the service was invoked via http.

Key Description

requestUrl String URL used by client to invoke the service.

query String Conditional. Query portion of request URL.

requestHdrs Document Fields in the request header, where key names represent header field names and values represent the header field values.

ipInfo Document Information about the http socket connection has a local ip address and a remote ip address (port also). Contains the following information:

Key Description

localIp String Local IP address for this socket connection to client.

localPort String Local port number for this socket connection to client.

remoteIp String Remote IP address for this socket connection to client.

remotePort String Remote port number for this socket connection to client.

ftp Document Conditional. Information about the ftp transport. Returned only if the ftp transport invoked the service.

Key Description

filename String Name of file that was put into the service directory.


pub.flow:transportInfo

Usage Notes

A document with this structure is output by the pub.flow:getTransportInfo service.

mimetype String Conditional. Content type of the file (for example, text/xml, text/plain, or image/jpeg). The server determines content type based on the extension of the file and the extension’s corresponding content type defined in webMethods6\IntegrationServer\lib\mime.types.

filePolling Document Conditional. Information about the file polling transport. Returned only if the file polling transport invoked the service.

Key Description

filename String Fully qualified name of the file submitted to the file polling listener.

originalFilename String Name of the file when it was submitted to the file polling listener.

contenttype String Conditional. Content type of the file (for example, text/xml, text/plain, or image/jpeg). The server determines content type based on the extension of the file and the extension’s corresponding content type defined in webMethods6\IntegrationServer\lib\mime.types.


C H A P T E R10
IO Folder
You use the elements in the io folder to convert data between byte[ ] and InputStream representations.


C H A P T E R 1 0 I O F o l d e r


pub. io:bytesToStreamWmPublic. Creates a java.io.ByteArrayInputStream from a byte[ ].

Input Parameters

Output Parameters

Usage Notes

This service constructs stream from the byte array using the constructor ByteArrayInputStream(byte[ ]). This constructor does not make a copy of the byte array, so any changes to bytes will be reflected in the data read from the stream.

pub. io:streamToBytesWmPublic. Creates a byte[ ] from data that is read from an InputStream.

Input Parameters

Output Parameters

Usage Notes

This service reads all of the bytes from stream until the end of file is reached, and then it closes the InputStream.


pub.io:bytesToStream WmPublic. Creates a java.io.ByteArrayInputStream from a byte[ ].

pub.io:streamToBytes WmPublic. Creates a byte[ ] from data that is read from an InputStream.

bytes byte[ ] The byte array that you want to convert.

stream java.io.ByteArrayInputStream An open InputStream created from the contents of bytes.

stream java.io.InputStream The InputStream that you want to convert.

bytes byte[ ] The bytes read from stream.


C H A P T E R11
LDAP Folder
You use the elements in the ldap folder to access and update information on an LDAP directory server.


C H A P T E R 11 L D A P F o l d e r


pub. ldap:bindWmPublic. Adds an entry into the LDAP server.

Input Parameters


pub.ldap:bind WmPublic. Adds an entry into the LDAP server.

pub.ldap:connect WmPublic. Connects to an LDAP server.

pub.ldap:delete WmPublic. Deletes an entry from the LDAP server.

pub.ldap:disconnect WmPublic. Closes a connection to an LDAP server.

pub.ldap:getAttributeDef WmPublic. Gets the definition of an attribute in the directory server’s schema.

pub.ldap:getClassDef WmPublic. Gets the definition of an objectclass in the directory server’s schema.

pub.ldap:list WmPublic. Lists the bindings within a particular directory context.

pub.ldap:lookup WmPublic. Looks up a single entry in the directory server.

pub.ldap:search WmPublic. Searches the directory for entries matching a set of criteria.

pub.ldap:update WmPublic. Modifies attributes of an entry in the LDAP directory.

ldapTargetName String Name of the entry that you want to add. For example, to add a user entry for Joe Krebbs in the ou=People context, specify cn=Joe Krebbs, ou=People for ldapTargetName.

ldapTargetObject Object Optional. Java Object that you want to store into this entry. Some LDAP servers restrict the kinds of objects you can store (some do not even support storage of Java objects). Typically, the objects must implement the java.io.Serializable interface. The default value for ldapTargetObject is null.

ldapTargetAttributes Document Optional. Attributes to assign to the new entry. The key/value pairs that you will need to supply in ldapTargetAttributes will vary depending on your LDAP server. Most servers will require an “objectclass” attribute, but other attributes are usually site-specific. Refer to the schema of your server to determine which attributes it requires. The following shows inputs you might use to add the user Joe Krebbs:


pub.ldap:connect

Output Parameters

None.

Usage Notes

You must have the appropriate permissions to add entries into an LDAP directory. For most simple insertions, you should not need to supply a Java object value for the ldapTargetObject input parameter.

pub. ldap:connectWmPublic. Connects to an LDAP server.

Input Parameters

Output Parameters

Usage Notes

The connection key returned by this service can be used to invoke the rest of the pub.ldap services (including pub.ldap:disconnect). The connection to the directory server remains open until the server shuts down or until the connection is disconnected.

To connect to a subdirectory, specify the URL of the subtree for ldapUrl. For example, if your directory starts at ldap://mydir.com and you only want to operate on the subtree rooted at ou=People, specify ldap://mydir.com/ou=People for ldapUrl.

Key Value

objectclass organizationalPerson

cn Joe

sn Krebbs

uid jkrebbs

mail [email protected]

ldapConnectionKey String Key for the connection to the directory server; this is the key returned by pub.ldap:connect.

ldapUrl String URL of the directory server to connect with. For example: ldap://bigfoot.com

ldapUser String Optional. User name to use to connect to the directory server.

ldapPass String Optional. Password to use to connect to the directory server.

ldapConnectionKey String Key for the connection to the directory server.



pub. ldap:deleteWmPublic. Deletes an entry from the LDAP server.

Input Parameters

Output Parameters

None.

Usage Notes

You must have the appropriate permissions to delete entries in an LDAP directory.

pub. ldap:disconnectWmPublic. Closes a connection to an LDAP server.

Input Parameters

Output Parameters

None.

Usage Notes

Use this service to disconnect from an LDAP server when you are done using the connection.

pub. ldap:getAttr ibuteDefWmPublic. Gets the definition of an attribute in the directory server’s schema.

Input Parameters

ldapLookupName String Name of the entry that you want to delete. For example, to delete Joe Krebbs from the ou=People context, specify cn=Joe Krebbs, ou=People for ldapLookupName.

ldapConnectionKey String Key for the connection to the directory server; this is the key returned from the execution of pub.ldap:connect.


ldapAttributeName String Name of the attribute for which you want to get the definition. For example, to get the definition of the “mail” attribute on the directory server, specify mail for ldapAttributeName.


pub.ldap:getClassDef

Output Parameters

Usage Notes

This service has been tested for the Netscape Directory servers. If you use a different LDAP directory server, test this service to ensure it works for your server.

pub. ldap:getClassDefWmPublic. Gets the definition of an objectclass in the directory server’s schema.

Input Parameters


ldapAttributeDef Document Definition of the attribute specified in ldapAttributeName. This document will contain the following information:

Key Description

NAME String Name of the objectclass.

NUMERICOID String Numeric OID of the objectclass.

SYNTAX String Numeric OID of the syntax for the attribute.

DESC String Description of this objectclass.

For example, the following shows what the returned output might look like for an attribute named “mail:”

Key Value

NAME mail

NUMERICOID 2.16.840.1.113730.3.2.2

SYNTAX 1.3.6.1.4.1.1466.115.121.1.15

DESC Standard Attribute

ldapObjectClass String Name of the objectclass for which you want to retrieve the definition. For example, to get the definition of the “organizationalPerson” class, specify organizationalPerson for ldapObjectClass.

ldapConnectionKey String Key for the connection to the directory server; this is the key returned by pub.ldap:connect.



Output Parameters

Usage Notes

This service has been tested for the Netscape Directory servers. If you use a different LDAP server, test this service to ensure it works for your server.

pub. ldap: l istWmPublic. Lists the bindings within a particular directory context.

Input Parameters

ldapObjectClassDef Document Definition of the objectclass specified in ldapObjectClass. This document will contain the following information:

Key Description

NAME String Name of the objectclass.

NUMERICOID String Numeric OID of the objectclass.

MAY String List Names of optional attributes.

MUST String List Names of required attributes.

DESC String Description of this objectclass.

SUP String Superclass of this objectclass.

For example, the following shows what the returned output might look like for a class named “inetOrgPerson:”

Key Value

NAME inetOrgPerson

NUMERICOID 2.16.840.1.113730.3.2.2

MAY acidescriptionssealsoetc.

MUST objectclasssncn

DESC Standard ObjectClass

SUP organizationalPerson



pub.ldap:list

Output Parameters

Usage Notes

Suppose the directory server running on myCompany.com contains an ou=Users context, which contains an entry (binding) for each user in the directory server. To list the user ID and email address of each user, specify the following input parameters for the pub.ldap:list service:

ldapListRoot String Optional. Relative name of the context to list. If you do not specify a value for ldapListRoot, the default is "", which indicates the root context for the directory server.

ldapReturnObjects String Optional. Flag that specifies whether you want the directory to return objects from the bindings or just the attributes. For example, if your directory contains persisted Java objects, you would set this attribute to true to have those objects returned.

Set to... To...

true Return objects from the bindings.

false Default. Return only attributes.

ldapReturnAttributes String Optional. Comma-separated list of attribute names to return for each of the listed bindings. For example, to return only the “mail” and “uid” attributes, you would set this parameter to mail,uid.

If you do not specify ldapReturnAttributes, all attributes are returned.

ldapListing Document List Conditional. Objects bound within the specified directory context. The list will contain one document for each object. Each document will contain the following information:

Key Description

$name String Fully qualified name of the binding.

$class String Conditional. Java class of the returned object. This key is present if you set ldapReturnObjects to true.

$object Object Conditional. Object bound to this name in the directory. This key is present if you set ldapReturnObjects to true.

ldapListing contains one set of keys for each returned attribute.

Key Value

ldapListRoot ou=Users

ldapReturnObjects false

ldapReturnAttributes uid,mail



The resulting document list might look like this (perhaps with more entries):

pub. ldap: lookupWmPublic. Looks up a single entry in the directory server.

Input Parameters

Key Value

$name cn=Arthur Milberg, ou=People

uid amilberg


$name n=Dorothy Hadden, ou=People

uid dhadden


$name cn=Scott Treezak, ou=People

uid streezak



ldapLookupName String Relative name of the context to look up (for example, ou=People, cn=Arthur Milberg).

ldapReturnObject String Optional. Flag that specifies whether you want the directory to return objects from the bindings or just the attributes. For example, if your directory contains persisted Java objects, you would set this attribute to true to have an object returned.

Set to... To...

true Return objects.


ldapReturnAttributes String Optional. Comma-separated list of attribute names to return for each of the listed bindings. For example, to return only the “mail” and “uid” attributes, set this parameter to mail,uid.

If you do not specify a value for ldapReturnAttributes, all attributes are returned.


pub.ldap:search

Output Parameters

Usage Notes

To reduce network traffic, it is recommended that you set the ldapReturnAttributes parameter to return a limited set of attributes. Try to avoid requesting all attributes.

pub. ldap:searchWmPublic. Searches the directory for entries matching a set of criteria.

Input Parameters

ldapObject Object Conditional. The object bound to the given name in the directory. This parameter is present if you set ldapReturnObject to true.

ldapAttributes Document Attributes associated with the given name in the directory. The document will contain one key for each attribute requested in ldapReturnAttributes.


ldapSearchFilter String Filter describing which entries to return. For example, to retrieve all entries with the objectClass “groupOfNames” and the cn of “Engineers”, you might use:

(&(objectclass=groupOfNames)(cn=Engineers))

For more information about LDAP search filters, consult your directory server documentation or look for RFC 1558.

ldapSearchRoot String Optional. Name of the context in which to start the search. Default is the root entry. The search will be recursive unless you specify the ldapSearchOneLevel parameter (see below). For example, to search only the “ou=Engineers” subcontext, you would set this parameter to ou=Engineers.

ldapSearchOneLevel String Optional. Flag specifying whether to search only the current node or the current node and everything below it.

Set to... To...

true Search only the current node.

false Default. Search the current node and everything below it.

ldapReturnObjects String Optional. Specifies whether the directory server is to return an object for the matching entries or just attributes. For example, if your directory contains persisted Java objects, you would set this attribute to true to receive the actual objects.



Output Parameters

Usage Notes

To reduce network traffic, speed up searches, and avoid returning unnecessary data, be specific when you define search criteria. Also keep in mind that different servers respond to search filters in different ways based on their schema. For instance, the (uid=a*) filter might be rejected on a server that does not allow substring searches on the uid attribute.

pub. ldap:updateWmPublic. Modifies attributes of an entry in the LDAP directory.

Input Parameters

Set to... To...

true Return objects.


ldapReturnAttributes String Optional. Comma-separated list of attribute names to return for each of the returned entries. For example, to return only the mail and uid attributes, set this parameter to mail, uid.

If you do not specify ldapReturnAttributes, all attributes are returned.

ldapSearchResults Document List Conditional. Objects matching the search filter. The list will contain one document for each object. Each document will contain the following information:

Key Description

$name String Fully qualified name of the binding.

$object byte[ ] Conditional. Object bound to this name on the directory server (returned only if you specified true for ldapReturnObjects).

ldapSearchResults contains one set of keys for each returned attribute.

ldapLookupName String Name of the entry that you want to modify. For example, to modify the entry for Joe Krebbs in the ou=People context, specify cn=Joe Krebbs, ou=People for ldapLookupName.

ldapConnectionKey String Key for the connection on the Integration Server; this is the key returned from the execution of pub.ldap:connect.

ldapAttributeMods Document List The changes that you want to make. For each change, provide a document (IData object) containing the following information:


pub.ldap:update

Output Parameters

None.

Usage Notes

You must have the appropriate permissions to modify entries in an LDAP directory. You cannot use this service to change the value of an entry itself (that is, if you have bound Java objects in your directory, you must delete them and rebind the name to a different Java object).

Key Description

$name String Name of the attribute to modify.

$modtype String Optional. Action to take. Specify remove, replace, or add. The default is add.

$value String Optional. New value to assign, if you are adding or replacing the attribute.

For example, the following shows the values you would use to change (replace) Joe Krebbs’ email address:

Key Value

$name mail

$modtype replace

$value [email protected]


C H A P T E R12
List Folder
You use the elements in the list folder to retrieve, replace, or add elements in an Object List, Document List, or String List. You also use list services to convert String Lists to Document Lists.


C H A P T E R 1 2 L i s t F o l d e r


pub. l ist :appendToDocumentListWmPublic. Adds documents to a document list.

Input Parameters


pub.list:appendToDocumentList WmPublic. Adds documents to a document list.

pub.list:appendToRecordList WmPublic. Deprecated—Use pub.list:appendToDocumentList. Adds documents to a document list.

pub.list:appendToStringList WmPublic. Adds Strings to a String list.

pub.list:copyListItem WmPublic. Deprecated—Copies an element from one index in an Object list to another index in a different Object list or the same Object list.

pub.list:getListItem WmPublic. Deprecated—Retrieves an element from an Object list.

pub.list:getRecordListItem WmPublic. Deprecated—Retrieves an individual document from a document list.

pub.list:getStringListItem WmPublic. Deprecated—Retrieves a String from a String list.

pub.list:setListItem WmPublic. Deprecated—Replaces an element in an Object list with a new element.

pub.list:setRecordListItem WmPublic. Deprecated—Replaces a document in a document list with a new document.

pub.list:setStringListItem WmPublic. Deprecated—Replaces a String in a String list with a new String.

pub.list:sizeOfList WmPublic. Returns the number of elements in a list.

pub.list:stringListToDocumentList WmPublic. Converts a String list to a document list.

pub.list:stringListToRecordList WmPublic. Deprecated—Use pub.list:stringListToDocumentList. Converts a String list to a document list.

toList Document List Optional. List to which you want to append documents. If you do not specify toList, the service creates a new list.

fromList Document List Optional. Documents you want to append to the end of toList.


pub.list:appendToRecordList

Output Parameters

Usage Notes

The documents contained in fromList and fromItem are not actually appended as entries to toList. Instead, references to the documents in fromList and fromItem are appended as entries to toList. Consequently, any changes made to the documents in fromList and fromItem also affect the resulting toList.

pub. l ist :appendToRecordListWmPublic. Deprecated—Use pub.list:appendToDocumentList. Adds documents to a document list.

Input Parameters

Output Parameters

Usage Notes

The documents contained in fromList and fromItem are not actually appended as entries to toList. Instead, references to the documents in fromList and fromItem are appended as entries to toList. Consequently, any changes made to the documents in fromList and fromItem also affect the resulting toList.

fromItem Document Optional. Document you want to append to the end of toList. If you specify both fromList and fromItem, the service adds the document specified in fromItem after the documents in fromList.

toList Document List The toList document list with the documents in fromList and fromItem appended to it.

toList Document List Optional. List to which you want to append documents. If you do not specify toList, the service creates a new list.

fromList Document List Optional. Documents to append to the end of toList. Documents are added after the entries of toList.

fromItem Document Optional. Document to append to the end of toList. If you specify both fromList and fromItem, the service adds the document specified in fromItem after the documents in fromList.

toList Document List The toList document list with the documents in fromList and fromItem appended to it.



pub. l ist :appendToStr ingListWmPublic. Adds Strings to a String list.

Input Parameters

Output Parameters

Usage Notes

The Strings contained in fromList and fromItem are not actually appended as entries to toList. Instead, references to the Strings in fromList and fromItem are appended as entries to toList. Consequently, any changes made to the Strings in fromList and fromItem also affect the resulting toList.

pub. l ist :copyList I temWmPublic. Deprecated—Copies an element from one index in an Object list to another index in a different Object list or the same Object list.

The copied element replaces the existing element in the destination index.

Input Parameters

Output Parameters

None.

toList String List Optional. List to which you want to append Strings. If the value of toList is null, a null pointer exception error is thrown. If you do not specify toList, the service creates a new list.

fromList String List Optional. List of Strings to add to toList. Strings are added after the entries of toList.

fromItem String Optional. String you want to append to the end of toList. If you specify both fromList and fromItem, the service adds the String specified in fromItem after the Strings specified in fromList.

toList String List The toList String list with the Strings from fromList and fromItem appended to it.

fromList Object Object list containing the element that you want to copy.

toList Object Object list in which you want to place the copied element.

fromIndex String Index of the element you want to copy.

toIndex String Index in which you want to place the copied element.


pub.list:getListItem

Usage Notes

String lists and document lists can also be used with this list service because they are also Object lists.

Note: To copy an element from one index in an object list to another index in the same object list, you can delete the toList on the Input/Output tab. Then, in the editor, map the fromList to the toList.

pub. l ist :getList I temWmPublic. Deprecated—Retrieves an element from an Object list.

Input Parameters

Output Parameters

pub. l ist :getRecordList I temWmPublic. Deprecated—Retrieves an individual document from a document list.

Input Parameters

Output Parameters

pub. l ist :getStr ingList I temWmPublic. Deprecated—Retrieves a String from a String list.

Input Parameters

list Object Object list containing the element you want to retrieve.

index String Index of the element you want to retrieve.

item Object Object at the specified index.

list Document List List containing the document you want to retrieve.

index String Index of the document you want to retrieve.

item Document Document at the specified index.

list String List List containing the String you want to retrieve.

index String Index of the String you want to retrieve.



Output Parameters

pub. l ist :setList I temWmPublic. Deprecated—Replaces an element in an Object list with a new element.

Input Parameters

Output Parameters

None.

pub. l ist :setRecordList I temWmPublic. Deprecated—Replaces a document in a document list with a new document.

Input Parameters

Output Parameters

None.

pub. l ist :setStr ingList I temWmPublic. Deprecated—Replaces a String in a String list with a new String.

Input Parameters

item String String at the specified index.

list Object Object list containing the element you want to replace.

index String Index of the element in list that you want to replace.

item Object Object to use to replace Object at index.

list Document List List containing the document you want to replace.

index String Index of the document in list that you want to replace.

item Document Document to use to replace document at index.

list String List List containing the String you want to replace.

index String Index of the String in list that you want to replace.

item String String to use to replace String at index.


pub.list:sizeOfList

Output Parameters

None.

pub. l ist :s izeOfListWmPublic. Returns the number of elements in a list.

Input Parameters

Output Parameters

Usage Notes

For example, if fromList consists of:

fromList[0] = "a"

fromList[1] = "b"

fromList[2] = "c"

The result would be:

size="3"

pub. l ist :str ingListToDocumentListWmPublic. Converts a String list to a document list.

Input Parameters

Output Parameters

fromList Document List, String List, or Object List Optional. List whose size you want to discover. If fromList is not specified, the service returns a size of 0.

size String Number of entries in fromList.

fromList Document List, String List or Object List Original list.

fromList String List Optional. List of Strings (a String[ ]) that you want to convert to a list of documents (an IData[ ]). If fromList is not specified, the service returns a zero length array for toList.

key String Optional. Key name to use in the generated document list.

toList Document List Resulting document list.



Usage Notes

Creates a document list containing one document for each element in the fromList. Each document will contain a single String element named key.


fromList[0] = "a"

fromList[1] = "b"

fromList[2] = "c"

key = "myKey"


pub. l ist :str ingListToRecordListWmPublic. Deprecated—Use pub.list:stringListToDocumentList. Converts a String list to a document list.

Input Parameters

Output Parameters

Usage Notes

Creates a document list containing one document for each element in the fromList. Each document will contain a single String element named key.


fromList[0] = "a"

fromList[1] = "b"

fromList[2] = "c"

fromList String List Optional. List you want to convert to a document list.

key String Optional. Key to use in the generated document list.

toList Document List Resulting document list.


pub.list:stringListToRecordList

key = "myKey"



C H A P T E R13
Math Folder
You use the elements in the math folder to add, subtract, multiply, or divide string-based numeric values.

Note: Services that operate on integer values use Java’s long data type (64-bit, two’s complement). Services that operate on float values use Java’s double data type (64-bit IEEE 754). If extremely precise calculations are critical to your application, you should write your own Java services to perform math functions.


C H A P T E R 1 3 M a t h F o l d e r



pub.math:addFloatList WmPublic. Adds a list of floating point numbers (represented in a String list) and returns the sum.

pub.math:addFloats WmPublic. Adds one floating point number (represented as a String) to another and returns the sum.

pub.math:addIntList WmPublic. Adds a list of integers (represented in a String list) and returns the sum.

pub.math:addInts WmPublic. Adds one integer (represented as a String) to another and returns the sum.

pub.math:addObjects WmPublic. Adds one java.lang.Number object to another and returns the sum.

pub.math:divideFloats WmPublic. Divides one floating point number (represented as a String) by another (num1/num2) and returns the quotient.

pub.math:divideInts WmPublic. Divides one integer (represented as a String) by another (num1/num2) and returns the quotient.

pub.math:divideObjects WmPublic. Divides one java.lang.Number object by another (num1/num2) and returns the quotient.

pub.math:multiplyFloatList WmPublic. Multiplies a list of floating point numbers (represented in a String list) and returns the product.

pub.math:multiplyFloats WmPublic. Multiples one floating point number (represented as String) by another and returns the product.

pub.math:multiplyIntList WmPublic. Multiplies a list of integers (represented in a String list) and returns the product.

pub.math:multiplyInts WmPublic. Multiplies one integer (represented as a String) by another and returns the product.

pub.math:multiplyObjects WmPublic. Multiplies one java.lang.Number object by another and returns the product.

pub.math:randomDouble WmPublic. Returns the next pseudorandom, uniformly distributed double between 0.0 and 1.0.

pub.math:subtractFloats WmPublic. Subtracts one floating point number (represented as a String) from another and returns the difference.


pub.math:addFloatList

pub.math:addFloatListWmPublic. Adds a list of floating point numbers (represented in a String list) and returns the sum.

Input Parameters

Output Parameters

Usage Notes

Make sure the strings that are passed to the service in numList are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling pub.math:addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

pub.math:subtractInts WmPublic. Subtracts one integer (represented as a String) from another and returns the difference.

pub.math:subtractObjects WmPublic. Subtracts one java.lang.Number object from another and returns the difference.


numList String List Numbers (floating point numbers represented as Strings) to add.

value String Sum of the numbers in numList. If a sum cannot be produced, value contains one of the following:

Value Description

Infinity The computation produces a positive value that overflows the representable range of a float type.

-Infinity The computation produces a negative value that overflows the representable range of a float type.

0.0 The computation produces a value that underflows the representable range of a float type (for example, adding a number to infinity).

NaN The computation produces a value that cannot be represented as a number (for example, any operation that uses NaN as input, such as 10.0 + NaN = NaN).



pub.math:addFloatsWmPublic. Adds one floating point number (represented as a String) to another and returns the sum.

Input Parameters

Output Parameters

Usage Notes

Make sure the strings that are passed to the service in num1 and num2 are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling pub.math:addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

pub.math:addIntListWmPublic. Adds a list of integers (represented in a String list) and returns the sum.

Input Parameters

num1 String Number to add.

num2 String Number to add.

value String Sum of the numbers in num1 and num2. If a sum cannot be produced, value contains one of the following:

Value Description



0.0 The computation produces a value that underflows the representable range of a float type (for example, adding a number to infinity).

NaN The computation produces a value that cannot be represented as a number (for example, any operation that uses NaN as input, such as 10.0 + NaN = NaN).

numList String List Numbers (integers represented as Strings) to add.


pub.math:addInts

Output Parameters

Usage Notes


pub.math:addIntsWmPublic. Adds one integer (represented as a String) to another and returns the sum.

Input Parameters

Output Parameters

Usage Notes

Make sure the result of your calculation is less than 64 bits in width (the maximum width for the long data type). If the result exceeds this limit, it will generate a data overflow.


pub.math:addObjectsWmPublic. Adds one java.lang.Number object to another and returns the sum.

Input Parameters

value String Sum of the numbers in numList.

num1 String Number (integer represented as a String) to add.

num2 String Number (integer represented as a String) to add.

value String Sum of num1 and num2.

num1 java.lang.Number Number to add. See “Usage Notes” for supported sub-classes.

num2 java.lang.Number Number to add. See “Usage Notes”” for supported sub-classes.



Output Parameters

Usage Notes

This service accepts the following sub-classes of java.lang.Number: java.lang.Byte, java.lang.Double, java.lang.Float, java.lang.Integer, java.lang.Long, java.lang.Short.

This service applies the following rules for binary numeric promotion to the operands in order:

If either operand is of type Double, the other is converted to Double.

Otherwise, if either operand is of type Float, the other is converted to Float.

Otherwise, if either operand is of type Long, the other is converted to Long.

Otherwise, both operands are converted to type Integer.

These promotion rules mirror the Java rules for numeric promotion of numeric types.

pub.math:divideFloatsWmPublic. Divides one floating point number (represented as a String) by another (num1/num2) and returns the quotient.

Input Parameters

Output Parameters

value java.lang.Number Sum of the numeric values of num1 and num2.

num1 String Number (floating point number represented as a String) that is the dividend.

num2 String Number (floating point number represented as a String) that is the divisor.

value String The quotient of num1 / num2. If a quotient cannot be produced, value contains one of the following:

Value Description



0.0 The computation produces a value that underflows the representable range of a float type (for example, dividing a number by infinity).


pub.math:divideInts

Usage Notes


pub.math:divideIntsWmPublic. Divides one integer (represented as a String) by another (num1/num2) and returns the quotient.

Input Parameters

Output Parameters

Usage Notes


pub.math:divideObjectsWmPublic. Divides one java.lang.Number object by another (num1/num2) and returns the quotient.

Input Parameters

NaN The computation produces a value that cannot be represented as a number (for example, the result of an illegal operation such as dividing zero by zero or any operation that uses NaN as input, such as 10.0 + NaN = NaN).

num1 String Number (integer represented as a String) that is the dividend.

num2 String Number (integer represented as a String) that is the divisor.

value String The quotient of num1 / num2.

num1 java.lang.Number Number that is the dividend. See “Usage Notes” for supported sub-classes.

num2 java.lang.Number Number that is the divisor. See “Usage Notes” for supported sub-classes.



Output Parameters

Usage Notes








pub.math:mult iplyFloatListWmPublic. Multiplies a list of floating point numbers (represented in a String list) and returns the product.

Input Parameters

Output Parameters

value java.lang.Number Quotient of num1 / num2.

numList String List Numbers (floating point numbers represented as Strings) to multiply.

value String Product of the numbers in numlist. If a product cannot be produced, value contains one of the following:

Value Description



0.0 The computation produces a value that underflows the representable range of a float type (for example, multiplying a number by infinity).

NaN The computation produces a value that cannot be represented as a number (for example, the result of an illegal operation such as multiplying zero by zero or any operation that uses NaN as input, such as 10.0 + NaN = NaN).


pub.math:multiplyFloats

Usage Notes


pub.math:mult iplyFloatsWmPublic. Multiples one floating point number (represented as String) by another and returns the product.

Input Parameters

Output Parameters

Usage Notes


num1 String Number (floating point number represented as a String) to multiply.

num2 String Number (floating point number represented as a String) to multiply.

value String Product of the numeric values of num1 and num2. If a product cannot be produced, value contains one of the following:

Value Description



0.0 The computation produces a value that underflows the representable range of a float type (for example, multiplying a number by infinity).

NaN The computation produces a value that cannot be represented as a number (for example, the result of an illegal operation such as multiplying zero by zero or any operation that uses NaN as input, such as 10.0 + NaN = NaN).



pub.math:mult iplyIntListWmPublic. Multiplies a list of integers (represented in a String list) and returns the product.

Input Parameters

Output Parameters

Usage Notes



pub.math:mult iplyIntsWmPublic. Multiplies one integer (represented as a String) by another and returns the product.

Input Parameters

Output Parameters

Usage Notes



numList String List Numbers (floating point numbers represented as Strings) to multiply.

value String Product of the numbers in numList.

num1 String Number (integer represented as a String) to multiply.

num2 String Number (integer represented as a String) to multiply.

value String Product of num1 and num2.


pub.math:multiplyObjects

pub.math:mult iplyObjectsWmPublic. Multiplies one java.lang.Number object by another and returns the product.

Input Parameters

Output Parameters

Usage Notes








pub.math:randomDoubleWmPublic. Returns the next pseudorandom, uniformly distributed double between 0.0 and 1.0.

Random number generators are often referred to as pseudorandom number generators because the numbers produced tend to repeat themselves over time.

Input Parameters

None.

Output Parameters

num1 java.lang.Number Number to multiply. See “Usage Notes” for supported sub-classes.

num2 java.lang.Number Number to multiply. See “Usage Notes” for supported sub-classes.

value java.lang.Number Product of num1 and num2.

number String Generated random number.



pub.math:subtractFloatsWmPublic. Subtracts one floating point number (represented as a String) from another and returns the difference.

Input Parameters

Output Parameters

Usage Notes


pub.math:subtract IntsWmPublic. Subtracts one integer (represented as a String) from another and returns the difference.

Input Parameters

num1 String Number (floating point number represented as a String).

num2 String Number (floating point number represented as a String) to subtract from num1.

value String Difference of num1 – num2. If a difference cannot be produced, value contains one of the following:

Value Description



0.0 The computation produces a value that underflows the representable range of a float type (for example, subtracting a number from infinity).

NaN The computation produces a value that cannot be represented as a number (for example, the result of an illegal operation such as multiplying zero by zero or any operation that uses NaN as input, such as 10.0 - NaN = NaN).

num1 String Number (integer represented as a String).


pub.math:subtractObjects

Output Parameters

Usage Notes



pub.math:subtractObjectsWmPublic. Subtracts one java.lang.Number object from another and returns the difference.

Input Parameters

Output Parameters

Usage Notes


This service applies the following rules for binary numeric promotion to the operands. The following rules are applied in order:






num2 String Number (integer represented as a String) to subtract from num1.

value String Difference of num1 – num2.

num1 java.lang.Number Number. See “Usage Notes” for supported sub-classes.

num2 java.lang.Number Number to subtract from num1. See “Usage Notes” for supported sub-classes.

value java.lang.Number Difference of num1 - num2.


C H A P T E R14
MIME Folder
You use the elements in the mime folder to create MIME messages and extract information from MIME messages.


C H A P T E R 1 4 M I M E F o l d e r


pub.mime:addBodyPartWmPublic. Adds a body part (header fields and content) to a specified MIME object.

Input Parameters

Service Function

pub.mime:addBodyPart WmPublic. Adds a body part (header fields and content) to a specified MIME object.

pub.mime:addMimeHeader WmPublic. Adds one or more header fields to a specified MIME object.

pub.mime:createMimeData WmPublic. Creates a MIME object.

pub.mime:getBodyPartContent WmPublic. Retrieves the content (payload) from the specified MIME object.

pub.mime:getBodyPartHeader WmPublic. Returns the list of header fields for the specified body part.

pub.mime:getContentType WmPublic. Returns the value of the Content-Type message header from the specified MIME object.

pub.mime:getEnvelopeStream WmPublic. Generates an InputStream representation of a MIME message from a specified MIME object.

pub.mime:getMimeHeader WmPublic. Returns the list of message headers from a specified MIME object.

pub.mime:getNumParts WmPublic. Returns the number of body parts in the specified MIME object.

pub.mime:getPrimaryContentType WmPublic. Returns the top-level portion of a MIME object’s Content-Type value.

pub.mime:getSubContentType WmPublic. Returns the sub-type portion of a MIME object’s Content-Type value.

pub.mime:mergeHeaderAndBody WmPublic. Concatenates the contents of the header and body returned by the pub.client:http service.

mimeData Document MIME object to which you want to add a body part. (This IData object is produced by pub.mime:createMimeData.)


pub.mime:addBodyPart

content java.io.InputStream or Object Content that you want to add to the MIME object. content can be an InputStream or another MIME object. Use an InputStream to add an ordinary payload. Use a MIME object to add a payload that is itself a MIME message.

isEnvStream String Flag that specifies whether content is to be treated as a MIME entity.

Important! This parameter is only used if content is an InputStream.

Set this parameter to one of the following values:

Set to... To...

yes Treat content as a MIME entity. addBodyPart will strip out the header fields from the top of content and add them to mimeData as part headers. The remaining data will be treated as the payload.

Note: addBodyPart assumes that all data up to the first blank line represents the entity’s header fields.

no Treat content as an ordinary payload.

mimeHeader Document Specifies the part headers that you want to add with this body part. Key names represent the names of the header fields. The values of the keys represent the values of the header fields.

For example, if you wanted to add the following header fields:X-Doctype: RFQX-Severity: 10

You would set mimeHeader as follows:

Key Value

X-Doctype RFQ

X-Severity 10

Be aware that the following MIME headers are automatically inserted by pub.mime:getEnvelopeStream when it generates the MIME message:

Message-IDMIME-Version

Additionally, you use the content, encoding, and description parameters to set the following fields:

Content-TypeContent-Transfer-EncodingContent-Description

If you set these header fields in mimeHeader and you create a single-part message, the values in contenttype, encoding, and description, if specified, will override those in mimeHeader. See usage notes.



contenttype String Optional. The value of the Content-Type header for this body part. For single-part messages, this value overrides the Content-Type value in mimeHeader, if one is present. Defaults to text/plain.

See usage notes.

encoding String Optional. Specifies how the body part is to be encoded for transport and sets the value of the Content-Transfer-Encoding header. For single-part messages, this value overrides the Content-Transfer-Encoding value in mimeHeader, if one is present. Defaults to 7bit.

See usage notes.

Note: This parameter determines how the payload is to be encoded for transport. When you add a payload to mimeData, it should be in its original format. The pub.mime:getEnvelopeStream service will perform the encoding (as specified by encoding) when it generates the final MIME message.

Set to... To...

7bit Default. Specify that content is 7-bit, line-oriented text that needs no encoding.

8bit Specify that content is 8-bit, line-oriented text that needs no encoding.

Note: This encoding value is not recommended for messages that will be transported via SMTP over the Internet, because the data can be altered by intervening mail servers that can’t accommodate 8-bit text. To safely transport 8-bit text, use quoted-printable encoding instead.

binary Specify that content contains binary information that needs no encoding.

Note: This encoding value is not recommended for messages that will be transported via SMTP over the Internet, because the data can be altered by intervening mail servers that can’t accommodate binary data. To safely transport binary data, use base64 encoding instead.

quoted-printable

Specify that content contains 7 or 8-bit, line-oriented text that you want to encode using the quoted-printable encoding scheme.

base64 Specify that content contains an arbitrary sequence of octets that you want to encode using the base64 encoding scheme.

uuencode Specify that content contains an arbitrary sequence of octets that you want to encode using the uuencode encoding scheme.

description String Optional. Specifies the value of the Content-Description header for this body part.


pub.mime:addBodyPart

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by pub.mime:createMimeData.

The way in which the contenttype and encoding parameters are applied depends on whether the finished message is single-part or multipart.

For single-part messages:

contenttype specifies the Content-Type for the entire MIME message. It overrides any value assigned to the Content-Type header in mimeHeader. If Content-Type is not specified in contenttype or mimeHeader, the value of the Content-Type header defaults to text/plain.

encoding specifies the Content-Transfer-Encoding for the entire MIME message. It overrides any value assigned to the Content-Transfer-Encoding header in mimeHeader. If Content-Transfer-Encoding is not specified in encoding or mimeHeader, the value of the Content-Transfer-Encoding header defaults to 7bit.

multipart String Optional. Flag that determines how addBodyPart behaves if mimeData already contains one or more body parts.

By default, addBodyPart simply appends a new body part to mimeData if it already contains a payload. (This allows you to construct multi-part messages.) However, you can override this behavior if you want to either replace the existing payload with the new body part or throw an exception under these circumstances (see replace parameter, below).

Set to... To...

yes Default. Append a new body part to mimeData.

no Replace the existing payload with the new body part. (Depending on the value of replace, this setting may cause addBodyPart to throw an exception.)

replace String Optional. Flag that specifies whether addBodyPart replaces the existing payload or throws an exception when it receives a mimeData that already contains a payload. This parameter is only used when multipart is set to no.

Set to... To...

yes Default. Replace the existing payload with the new body part.

no Throw an exception.

mimeData Document MIME object to which the body part was added.



For multipart messages:

contenttype specifies the Content-Type for an individual body part. The Content-Type for the entire MIME message is automatically set to multipart/mixed, or to multipart/subType if a subtype was specified when the MIME object was created. See pub.mime:createMimeData.

encoding specifies the Content-Transfer-Encoding for an individual body part. The Content-Transfer-Encoding header in mimeHeader, if present, specifies the encoding for the entire MIME message. If Content-Transfer-Encoding is not specified in mimeHeader, or if the specified value is not valid for a multipart message, the value of the Content-Transfer-Encoding header defaults to 7bit. (7bit, 8bit, and binary are the only encoding values valid for multipart messages.)

For general information about MIME messages and using the MIME services, see the MIME-S/MIME Developer’s Guide.

See Also

pub.mime:createMimeDatapub.mime:getBodyPartContentpub.mime:addMimeHeader

Examples

For examples of how to use this service, see the following services, which reside in the WmSamples package on your webMethods Integration Server.

samples.mime:build_SimpleMIMEsamples.mime:build_MultipartMIME

pub.mime:addMimeHeaderWmPublic. Adds one or more header fields to a specified MIME object.

Input Parameters

mimeData Document MIME object to which you want the header fields added. (This IData object is produced by pub.mime:createMimeData.)

mimeHeader Document Header fields that you want to add to the MIME object. Key names represent the names of the header fields. The values of the keys represent the values of the header fields. For example, to add the following header fields:

X-Doctype: RFQX-Severity: 10


Key Description

X-Doctype RFQ

X-Severity 10


pub.mime:addMimeHeader

Output Parameters

Usage Notes


If you add MIME headers before you add multiple body parts, the header fields will be added to each of the body parts. If you do not want this behavior, either drop mimeHeader from the pipeline immediately after you execute addMimeHeader, or invoke addMimeHeader after you’ve added all body parts to the MIME object.

Be aware that the contenttype and encoding parameters used by the pub.mime:addBodyPart service will override any Content-Type or Content-Transfer-Encoding settings in mimeData. Moreover, in certain cases, the pub.mime:getEnvelopeStream will override these settings when it generates a multipart message. For information about how the Content-Type or Content-Transfer-Encoding headers are derived at run time, see the “Usage Notes”under pub.mime:addBodyPart.


See Also

pub.mime:createMimeDatapub.mime:getMimeHeaderpub.mime:addBodyPart

Examples


samples.mime:build_SimpleMIME



If you set these values in mimeHeader, pub.mime:getEnvelopeStream will overwrite them at run time.

mimeData Document MIME object to which the header fields were added.



pub.mime:createMimeDataWmPublic. Creates a MIME object.

If no input parameter is passed to this service, the service creates an empty MIME object. Otherwise, the service creates a MIME object containing the elements (header fields and content) from the MIME message in input.

If you are building a MIME message, you use this service to create an empty MIME object. You populate the empty MIME object with header fields and content, and then pass it to pub.mime:getEnvelopeStream, which produces the finished MIME message.

If you are extracting data from a MIME message, you use this service to parse the original MIME message into a MIME object so that you can extract its header fields and content using other webMethods services.

Input Parameters

input java.io.InputStream Optional. MIME entity you want to parse. If input is not provided, createMimeData creates an empty MIME object.

mimeHeader Document Optional. Specifies header fields that you want to add to the MIME object. Key names represent the names of the header fields. The values of the keys represent the values of the header fields.

Note: This parameter is ignored when input is passed to this service.

For example, if you wanted to add the following header fields:X-Doctype: RFQX-Severity: 10


Key Value

X-Doctype RFQ

X-Severity 10



If you set these values in mimeHeader, pub.mime:getEnvelopeStream will overwrite them at run time.


pub.mime:createMimeData

Output Parameters

Usage Notes

All of the other MIME services operate on the mimeData IData object produced by this service. They do not operate directly on MIME message streams.

Important! You can examine the contents of mimeData during testing and debugging. However, because the internal structure of mimeData is subject to change without notice, do not explicitly set or map data

subType String Optional. String that specifies the subtype portion of the Content Type header, when the message is a multipart message and \you want something other than the default value of mixed. For example, if you want the Content Type header to be multipart/related in the resulting message, set subType to related.

subType is ignored if the resulting message is not a multipart message.

mimeData Document MIME object. If input was passed to createMimeData, mimeData will contain the parsed MIME message. If input was not passed to createMimeData, mimeData will be empty.

encrypted String Conditional. Indicates whether input was an encrypted message. This parameter is not present when the service creates a new, empty MIME object.


true The message is encrypted (the original message stream is in stream).

false The message is not encrypted.

signed String Conditional. Flag whose value indicates whether input was a signed message. This parameter is not present when the service creates a new, empty MIME object.


true The message is signed (the original message stream is in stream).

false The message is not signed.

certsOnly String Conditional. Flag whose value indicates whether input contained only digital certificates. (This type of message can be produced by the pub.smime:createCertsOnlyData service and allows digital certificates to be transported via the network as a MIME message.) This parameter is not present when the service creates a new, empty MIME object.


true The message contains only certificates.

false The message contains a regular payload.

stream java.io.InputStream Conditional. InputStream containing the original MIME message from input. This parameter is present only when input is an S/MIME message.



to/from these elements in your service. To manipulate or access the contents of mimeData, use only the MIME services that webMethods provides.


See Also

pub.mime:addMimeHeaderpub.mime:addBodyPartpub.mime:getMimeHeaderpub.mime:getBodyPartContentpub.mime:getEnvelopeStream

Examples


samples.mime:build_SimpleMIMEsamples.mime:build_MultipartMIMEsamples.mime:extract_SimpleMIMEsamples.mime:extract_MultipartMIME

pub.mime:getBodyPartContentWmPublic. Retrieves the content (payload) from the specified MIME object.

You use this service for both single-part and multi-part messages.

To retrieve content from a multi-part message, you set the index (to select the part by index number) or contentID (to select the part by contentID value) parameter to specify the body part whose content you want to retrieve. To get the content from a single-part message, you omit the index and contentID parameters or set index to 0.

Input Parameters

mimeData Document MIME object whose content you want to retrieve. (This IData object is produced by pub.mime:createMimeData.)

index String Optional. Index number of the body part whose content you want to retrieve (if you want to retrieve the content from a specific body part). The first body part is index number zero.

Note: If contentID is specified, index is ignored.

contentID String Optional. Value of the Content-ID header field of the body part whose content you want to retrieve (if you want to retrieve the payload from a specific body part).


pub.mime:getBodyPartContent

Output Parameters

Usage Notes


If you omit index or contentID when retrieving content from a multi-part message, getBodyPartContent returns the payload from the first body part. If you use index or contentID to select a body part that does not exist in mimeData, content will be null.


See Also

pub.mime:createMimeDatapub.mime:addBodyPartpub.mime:getBodyPartHeader

Examples


samples.mime:extract_SimpleMIMEsamples.mime:extract_MultipartMIME

content java.io.InputStream The payload of the specified body part.

encrypted String Flag whose value indicates whether content is an encrypted MIME message.


true content is an encrypted message.

false content is not an encrypted message.

signed String Flag indicating whether content is a signed MIME message.


true content is a signed MIME message.

false content is not a signed MIME message.

certsOnly String Flag whose value indicates whether content is a certs-only MIME message.


true content is a certs-only message.

false content is not a certs-only message.



pub.mime:getBodyPartHeaderWmPublic. Returns the list of header fields for the specified body part.

Input Parameters

Output Parameters

Usage Notes


If you omit index or contentID, getBodyPartHeader returns the message headers from the first body part. If you use index or contentID to select a body part that does not exist in mimeData, content will be null.


mimeData Document MIME object whose message headers you want to retrieve. (This IData object is produced by pub.mime:createMimeData)

index String Optional. Index number of the body part whose header fields you want to retrieve. The first body part is index zero.

Note: If contentID is specified, index is ignored.

contentID String Optional. Value of the Content-ID header field of the body part whose header fields you want to retrieve.

mimeHeader Document IData object containing the message headers. Key names represent the names of the header fields. The value of a key represents the value of that header field.

For example, if the original message contained the following message header fields:Content-Type: text/xmlX-Doctype: RFQX-Severity: 0

getBodyPartHeader would return the following IData object:

Key Value

Content-Type text/xml

X-Doctype RFQ

X-Severity 0


pub.mime:getContentType

See Also

pub.mime:createMimeDatapub.mime:addBodyPartpub.mime:getMimeHeader

pub.mime:getContentTypeWmPublic. Returns the value of the Content-Type message header from the specified MIME object.

Input Parameters

Output Parameters

Usage Notes



See Also

pub.mime:createMimeDatapub.mime:getSubContentTypepub.mime:getPrimaryContentTypepub.mime:getMimeHeaderpub.mime:getBodyPartHeader

mimeData Document MIME object whose Content-Type you want to discover. (This IData object is produced by pub.mime:createMimeData.)

contentType String Value of the MIME object’s Content-Type header field. Note that this service returns only the media type and subtype portion of this header field’s value. It does not return any parameters the value may include. For example, if the message’s Content-Type header were:

Content-Type: text/plain;charset=UTF8

contentType would contain:text/plain



pub.mime:getEnvelopeStreamWmPublic. Generates an InputStream representation of a MIME message from a specified MIME object.

Input Parameters

Output Parameters

Usage Notes


mimeData Document MIME object from which you want to generate the MIME message. (This IData object is produced by pub.mime:createMimeData.)

index String Optional. Index number of the body part for which you want to generate the MIME message (if you want to generate the message from a specific body part). The first body part is index number zero.

contentID String Optional. Value of the Content-ID header field of the body part from which you want to generate the MIME message (if you want to generate the message from a specific body part).

Note: If index is specified, contentID is ignored.

suppressHeaders String List Optional. Names of header fields that are to be omitted from message. You can use this option to exclude header fields that getEnvelopeStream generates by default, such as Content-Type and content-encoding.

createMultipart String Optional. Specifies whether a multipart message is to be created, even if mimeData contains only one body part.

Set to... To...

yes Create a multipart message (Content-Type message header is set to “multipart/mixed”).

no Default. Create a message based on the number of body parts in mimeData.

If the message contains only one body part, Content-Type is set according to the contenttype setting specified when that body part was added to mimeData.

If the message contains multiple body parts, Content-Type is automatically set to “multipart/mixed.”

envStream java.io.InputStream The MIME message as an InputStream.


pub.mime:getMimeHeader

If you omit index or contentID, getEnvelopeStream generates the MIME message from the entire contents of the mimeData. If you use index or contentID to select a body part that does not exist in mimeData, content will be null.

getEnvelopeStream automatically inserts the MIME-Version and Message-ID message headers into the MIME message it puts into envStream.


See Also

pub.mime:createMimeDatapub.mime:addBodyPartpub.mime:addMimeHeader

Examples


samples.mime:build_SimpleMIMEsamples.mime:build_MultipartMIME

pub.mime:getMimeHeaderWmPublic. Returns the list of message headers from a specified MIME object.

Input Parameters

Output Parameters

mimeData Document MIME object whose message headers you want to retrieve. (This IData object is produced by pub.mime:createMimeData.)

mimeHeader Document Conditional. An IData object containing the message headers. Key names represent the names of the header fields. The value of a key represents the value of the header fields.

For example, if the original message contained the following message header fields:Message-ID: <[email protected]>From: "[email protected]" <[email protected]>To: <[email protected]>MIME-Version: 1.0Content-Type: text/xmlX-Doctype: RFQX-Severity: 0

getMimeHeader would return the following:



Usage Notes



See Also

pub.mime:createMimeDatapub.mime:addMimeHeaderpub.mime:getBodyPartHeader

pub.mime:getNumPartsWmPublic. Returns the number of body parts in the specified MIME object.

Input Parameters

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by createMimeData.


Key Value

Message-ID <[email protected]>

From "[email protected]" <[email protected]>

To <[email protected]>

MIME-Version 1.0

Content-Type text/xml

X-Doctype RFQ

X-Severity 0

mimeData Document MIME object whose parts you want to count. (This IData object is produced by pub.mime:createMimeData.)

numParts String The number of body parts in the MIME object.


pub.mime:getPrimaryContentType

See Also

pub.mime:createMimeDatapub.mime:getBodyPartContentpub.mime:addBodyPart

Examples


samples.mime:extract_MultipartMIME

pub.mime:getPrimaryContentTypeWmPublic. Returns the top-level portion of a MIME object’s Content-Type value.

Input Parameters

Output Parameters

Usage Notes



See Also

pub.mime:createMimeDatapub.mime:getContentTypepub.mime:addMimeHeaderpub.mime:getBodyPartHeader

mimeData Document MIME object whose Content-Type you want to discover. (This IData object is produced by pub.mime:createMimeData.)

primContentType String Message’s top-level Content-Type. For example, if the message’s Content-Type header were:

Content-Type: multipart/mixed

primContentType would contain:multipart



pub.mime:getSubContentTypeWmPublic. Returns the sub-type portion of a MIME object’s Content-Type value.

Input Parameters

Output Parameters

Usage Notes


For general information about MIME messages and using the MIME services, see the MIME-S/MIME Developer’s Guidee.

See Also

pub.mime:createMimeDatapub.mime:getContentTypepub.mime:addMimeHeaderpub.mime:getBodyPartHeader

pub.mime:mergeHeaderAndBodyWmPublic. Concatenates the contents of the header and body returned by the pub.client:http service.

You can use this service to reassemble the message into its original form so that it can be used as input to the pub.mime:createMimeData service (or any other service that requires the entire http response as an InputStream).

Input Parameters

mimeData Document MIME object whose sub-type you want to discover. (This IData object is produced by pub.mime:createMimeData.)

subContentType String Message’s sub-type. For example, if the message’s Content-Type header were:Content-Type: multipart/mixed

subContentType would contain:mixed

headerLines Document IData object containing the message headers returned by pub.client:http. (The message headers are returned in the lines document inside the header output parameter that is produced by pub.client:http.)

body Document IData object containing the body of the message returned by pub.client:http. This document must contain the body of the message in one of the following keys:


pub.mime:mergeHeaderAndBody

Output Parameters

Usage Notes

Use this service to merge the results produced by pub.client:http to get the original MIME message.

See Also

pub.client:httppub.mime:createMimeData

Key Description

bytes byte[ ] Optional. Body of the message (if pub.client:http returned the body as a byte[ ]).

stream java.io.InputStream Optional. The body of the message (if pub.client:http returned the body as an InputStream).

stream java.io.InputStream InputStream containing the reassembled http message.


C H A P T E R15
Packages Folder
You use the elements in the packages folder to install, load, and/or alter the status of a package on the Integration Server.


C H A P T E R 1 5 P a c k a g e s F o l d e r


pub.packages:act ivatePackageWmPublic. Activates (makes available to clients) an inactive package.

You use this service to activate a package that was not activated when it was initially installed or recovered.

Note: This service activates packages from an inactive state (that is, packages that are installed on the server but are not registered in the active-package list). To enable a package that is in a disabled state, you use pub.packages:enablePackage.

Input Parameters

Output Parameters

Usage Notes

This service will throw an exception if the package specified in package does not exist or cannot otherwise be activated.


pub.packages:activatePackage WmPublic. Activates (makes available to clients) an inactive package.

pub.packages:disablePackage WmPublic. Disables a package, thus prohibiting access to the services in the package.

pub.packages:enablePackage WmPublic. Enables a package that has been disabled.

pub.packages:installPackage WmPublic. Installs a package that has been published to this server.

pub.packages:recoverPackage WmPublic. Recovers a package that exists in the server’s salvage directory.

pub.packages:reloadPackage WmPublic. Loads a new copy of the package into memory from disk.

package String Name of the package that you want to activate. Package names are case sensitive.

message String Message from server. (This is the same message that you receive when you activate a package with the Integration Server Administrator.)


pub.packages:disablePackage

When a package is activated, it is loaded into memory in an enabled state (that is, activatePackage automatically activates and enables the package.) You do not need to explicitly enable it with pub.packages:enablePackage.

See Also

pub.packages:enablePackagepub.packages:installPackagepub.packages:recoverPackage

pub.packages:disablePackageWmPublic. Disables a package, thus prohibiting access to the services in the package.

Input Parameters

Output Parameters

Usage Notes

When a package is disabled, the services in the package are no longer available to the clients. To re-enable a package that has been disabled, use pub.packages:enablePackage.

Important! Never disable the WmRoot package. Doing so would disable the server.

Be aware that if you disable a package while services in the package are being executed, those services will most likely fail. disablePackage does not wait for in-progress services to finish before disabling a package.

This service will throw an exception if the package specified in package does not exist or cannot otherwise be disabled.

See Also

pub.packages:enablePackage

package String Name of the package that you want to disable. Package names are case sensitive.

message String Message from server. (This is the same message that you receive when you disable a package with the Integration Server Administrator.)



pub.packages:enablePackageWmPublic. Enables a package that has been disabled.

Note: This service enables a package that is in a disabled state (that is, a package that has been disabled through the Integration Server Administrator or the pub.packages:disablePackage service). To activate a package that is in an inactive state, you use enablePackage.

Input Parameters

Output Parameters

Usage Notes

When you enable a package, the package is reloaded into memory from disk.

This service will throw an exception if the package specified in package does not exist, has not been activated, or cannot otherwise be enabled.

See Also

pub.packages:disablePackagepub.packages:activatePackagepub.packages:reloadPackage

pub.packages: instal lPackageWmPublic. Installs a package that has been published to this server.

Input Parameters

package String Name of the package that you want to enable. Package names are case sensitive.

message String Message from server. (This is the same message that you receive when you enable a package with the Integration Server Administrator.)

packageFile String Name of the distribution file that contains the package that you want to install. This file must reside in the server’s inbound directory (webMethods6\IntegrationServer\replicate\inbound).

When specifying packageFile,

Do include the .zip extension in the file name.

Do not include the directory path.

For example: myPackageFileAug2001.zip


pub.packages:recoverPackage

Output Parameters

Usage Notes

If the installed package replaces an existing package on the server, installPackage will automatically put a backup copy of the existing package in webMethods6\IntegrationServer\replicate\salvage before it installs the new package.

This service will throw an exception if the file named in packageFile does not exist or cannot otherwise be installed correctly.

See Also

pub.packages:activatePackagepub.packages:recoverPackage

pub.packages:recoverPackageWmPublic. Recovers a package that exists in the server’s salvage directory.

The salvage directory (webMethods6\IntegrationServer\replicate\salvage) is where the server keeps packages that are deleted with the “safe delete” option or replaced with newer installed versions.

Input Parameters

activateOnInstall String Flag that specifies whether you want the server to automatically activate the package after it is installed.

Set to... To...

yes Activate the package after installation and make it immediately available to clients.

no Install the package without activating it afterwards. If you install a package in this mode, it will not be accessible until it is explicitly activated through the Integration Server Administrator or the pub.packages:activatePackage service.

message String Message from server. (This is the same message that is displayed when you install a package with the Integration Server Administrator.)

package String Name of the package that you want to recover. Package names are case sensitive.

activateOnRecover String Flag that specifies whether you want the server to automatically activate the package after it is recovered.



Output Parameters

Usage Notes

You can only recover packages that exist in the server’s salvage directory.

If you recover a package that is currently installed on the server, the package from the salvage directory replaces the version that is currently installed. (Be aware that the server does not retain a copy of the version that it replaces.)

This service will throw an exception if the file named in package does not exist in the server’s salvage directory or cannot otherwise be recovered.

See Also

pub.packages:activatePackage

pub.packages:reloadPackageWmPublic. Loads a new copy of the package into memory from disk.

If you make changes to the service in a package while the server is running, you must use reloadPackage to put those changes into effect.

Input Parameters

Output Parameters

Set to... To...

yes Activate the package after it is recovered and make it immediately available to clients.

no Recover the package without activating it afterwards. If you recover a package in this mode, it will not be accessible until it is explicitly activated through the Integration Server Administrator or the pub.packages:activatePackage service.

message String Message from server. (This is the same message that is displayed when you recover a package with the Integration Server Administrator.)

package String Name of the package that you want to reload. Package names are case sensitive.

message String Message from server. (This is the same message that is displayed when you reload a package with the Integration Server Administrator.)


pub.packages:reloadPackage

Usage Notes

Be aware that if you reload a package while services in the package are being executed, those services will most likely fail. reloadPackage does not wait for in-progress services to finish before reloading a package.

This service will throw an exception if the file named in package does not exist or cannot otherwise be reloaded.


C H A P T E R16
PKI Folder
You use the elements in the pki folder to create and verify PKCS#7 signatures with PKI profiles. You also use elements in this folder to create and process S/MIME messages using PKI profiles.


C H A P T E R 1 6 P K I F o l d e r


pub.pki .pkcs7:signWmPKI. Creates a PKCS7 SignedData object using a PKI profile.

This service enables multiple entities to sign the specified data. Each signerInfo block contained in the resulting signature contains two authenticated attributes: the content type and a timestamp.

Note: This service is similar to pub.security.pkcs7:sign except that it uses a PKI profile to create the PKCS7 SignedData object.

Input Parameters


pub.pki.pkcs7:sign WmPKI. Creates a PKCS7 SignedData object using a PKI profile.

pub.pki.pkcs7:verify WmPKI. Processes a digital signature to make sure that the provided data has not been modified.

pub.pki.smime.createSignedAndEncryptedData WmPKI. Digitally signs a MIME message and then encrypts it.

pub.pki.smime.createSignedData WmPKI. Digitally signs a MIME message using a specified PKI profile.

pub.pki.smime:processEncryptedData WmPKI. Decrypts an encrypted S/MIME message using a specified PKI profile.

pub.pki.smime:processSignedData WmPKI. Verifies the signature from a signed S/MIME entity using a specified PKI profile, and then extracts the message from the S/MIME entity.

signerInfo Document List Information about a single signer of the signed data object.

Note: This service accepts only one signerInfo.

Key Description

profileAlias String PKI profile alias used to sign the data. This service retrieves the key from the profile to perform the signing operation and includes the associated public and CA certificates in the signature that it generates.

hashAlgorithm String Optional. The algorithm to use when computing the digest of the provided data (SHA-1 or MD5). The default value is SHA-1.


pub.pki.pkcs7:verify

Output Parameters

pub.pki .pkcs7:ver i fyWmPKI. Processes a digital signature to make sure that the provided data has not been modified.

Note: This service is similar to pub.security.pkcs7:verify except that it uses a PKI profile to obtain the certificate against which to verify the signer’s signature.

Input Parameters

data byte[ ] Data to be digitally signed.

detachedSignature String Flag specifying whether to generate a detached signature. A detached signature does not include the data that was signed.

Set to... To...

true Generate a detached signature.

false Default. Generate an implicit signature (one that includes the signed data).

signature byte[ ] Signature generated from the supplied data. This is a DER-encoded representation of the SignedData object as specified in PKCS#7.

profileAlias String Name of the PKI profile to be used for certificate verification.

signature byte[ ] Signature to use to determine whether the signed data is intact (a DER-encoded representation of the SignedData object as specified in PKCS#7). If you are processing a detached signature, pass the signature in signature. If you are processing an implicit signature, pass the entire signed entity in signature.

data byte[ ] Optional. The data that was signed. If you are processing an implicitly signed message, you do not need to supply data because both the data and the signature reside in signature.

detachedSignature String Flag indicating whether the message has a detached signature.

Key Description

true The message has a detached signature.

false Default. The message has an implicit signature.

signerCertChain byte[ ][ ] Optional. Certificate chains of the parties that signed the message.

Note: If the signers included the certificate chain with the digital signature, you do not need to supply signerCertChain.



Output Parameters

pub.pki .smime.createSignedAndEncryptedDataWmPKI. Digitally signs a MIME message and then encrypts it.

Note: This service is similar to pub.smime:createSignedAndEncryptedData except that a PKI profile is used to provide signing key and certificate information.

Input Parameters

content byte[ ] Conditional. The data (for example, the document that was originally signed) extracted from an implicit signature. If you are verifying a detached signature, content is not returned.

Note: The extracted data is returned in content even if signature verification fails.

signerInfo Document List Information about the signers. Each document in the list provides the following information about a single signer:

Key Description

certChain java.security.cert.X509Certificate[ ] Certificate chain of the signer. The chain will appear in hierarchical order, starting with the signer’s X.509 certificate in element 0.

timeStamp java.util.Date Time at which the signer signed the data.

trusted String Flag indicating whether the certificate chain presented by the signer is trusted.


true The chain is trusted.

false The chain is not trusted.

status String Code indicating whether the signatures were successfully verified. If successful, status contains verified. If the signatures were not successfully verified, status contains an error message.

errorMessage String Conditional. If the signatures were not successfully verified, this parameter contains the text “Invalid signer certificate file information.”

envStream java.io.InputStream The MIME message that you want to sign and encrypt (for example, the output produced by pub.mime:getEnvelopeStream).

profileAlias String PKI profile alias to use to sign the data. This service retrieves the key from the profile to perform the signing operation and includes the associated public and CA certificates in the signature that it generates.


pub.pki.smime.createSignedData

Output Parameters

pub.pki .smime.createSignedDataWmPKI. Digitally signs a MIME message using a specified PKI profile.

Note: This service is similar to pub.smime:createSignedData except that a PKI profile supplies signing key and certificate information.

Input Parameters

explicit String Optional. Flag indicating whether an implicit or explicit signature is to be generated.

Set to... To...

true Default. Generate an explicit (detached) signature.

false Generate an implicit signature.

recipientCerts byte[ ][ ] X.509 certificates of the recipients for whom this message will be encrypted. Each element in the list contains the certificate for a single recipient, in the form of a byte array.

Note: For multiple recipients, this service creates a single message that is encrypted for all recipients. It does not create a separate message for each recipient.

encryptionAlg String Optional. Code specifying the encryption algorithm to use. Must be one of the following values:

TripleDESDESRC2

Default is TripleDES

keyLength String Optional. Length of the encryption key for RC2 encryption. Must be one of the following values:

4064128

Default is 128. This parameter is ignored if encryptionAlg is not RC2.

SMimeEnvStream java.io.InputStream Signed and encrypted MIME message.

envStream java.io.InputStream MIME message that you want to sign (for example, the output produced by pub.mime:getEnvelopeStream).



Output Parameters

pub.pki .smime:processEncryptedDataWmPKI. Decrypts an encrypted S/MIME message using a specified PKI profile.

Note: This service is similar to pub.smime:processEncryptedData except that a PKI profile supplies signing key and certificate information.

Input Parameters

Output Parameters

profileAlias String PKI profile alias to use to sign the message. This service retrieves the key from the profile to perform the signing operation and includes the associated public and CA certificates in the signature that it generates.


Set to... To...



SMimeEnvStream java.io.InputStream Signed MIME message.

SMimeEnvStream java.io.InputStream The encrypted S/MIME entity (for example, the output produced by pub.smime:createEncryptedData).

profileAlias String PKI profile to use to decrypt the message. This service retrieves the decryption key and public encryption certificate from the profile to perform the decryption operation.

mimeData Document MIME object containing the decrypted MIME message.

contentDigest String Message digest of the encrypted content, base64-encoded. (Some sites return this digest to the sender to acknowledge their receipt of the message.)

encrypted String Conditional. Flag indicating whether the decrypted MIME entity is encrypted.


true The MIME entity is encrypted.

false The MIME entity is not encrypted.

signed String Conditional. Flag indicating whether the decrypted MIME entity is signed.


pub.pki.smime:processSignedData

pub.pki .smime:processSignedDataWmPKI. Verifies the signature from a signed S/MIME entity using a specified PKI profile, and then extracts the message from the S/MIME entity.

Note: This service is like pub.smime:processSignedData except that a PKI profile supplies the certificates against which the signature is verified.

Input Parameters


true The MIME entity is signed.

false The MIME entity is not signed.

certsOnly String Conditional. Flag indicating whether the decrypted MIME entity is a certs-only entity.


true The MIME entity is a certs-only entity.

false The MIME entity is not a certs-only entity.

stream java.io.InputStream Conditional. The decrypted MIME entity. This parameter is present only when the decrypted entity is an S/MIME message.

SMimeEnvStream java.io.InputStream Signed MIME entity (for example, the output produced by pub.pki.smime.createSignedData).

profileAlias String PKI profile to use for certificate validation.

signerCertChain byte[ ][ ] Optional. Certificate chain of the party that signed the message. Certificates must appear in hierarchical order, starting with the signer’s certificate in element 0.

The following shows how the elements of a complete chain would appear for a certificate that was issued through two intermediate CAs.

Element Contents

0 Signer’s certificate

1 Intermediary CA Certificate

2 Intermediary CA Certificate

3 Root CA Certificate

Note: If the signer included the certificate chain with the digital signature, you do not need to supply signerCertChain.



Output Parameters

mimeData Document MIME object containing the extracted MIME entity.

contentDigest String Message digest (base64-encoded) that processSignedData recalculated.

signerCert java.security.cert.X509Certificate Signer’s X509 certificate.

encrypted String Conditional. Flag indicating whether the extracted MIME entity is encrypted.




signed String Conditional. Flag indicating whether the extracted MIME entity is signed.




certsOnly String Conditional. Flag indicating whether the extracted MIME entity is a certs-only entity.




stream java.io.InputStream Conditional. Extracted MIME entity. This parameter is present only when the decrypted entity is an S/MIME message.

verify String Flag indicating whether the signature was successfully processed (that is, the signature was successfully verified with the public key supplied by the PKI profile).


true Signature processing was successful.

false Signature processing failed. The signature could not be verified because errorCode 1 or 4 occurred (see errorCode below).

trusted String The signer is a trusted entity. For the signer to be trusted, the signer’s certificate or one of its root certificates should be present in the trusted CA directory.


true The signer is a trusted entity.

false The signer is not a trusted entity.


pub.pki.smime:processSignedData

Usage Notes

If verify is false, the errorCode and errorMessage values will indicate the error that caused the failure. Note that errorCode values 5 through 7 do not represent signature-verification failures, and therefore do not cause the verify flag to be set to false.

If the extracted entity is signed or encrypted, mimeData will be empty and the extracted entity will reside in stream. You can check the state of the signed and encrypted output variables to determine whether the extracted entity requires additional processing, then pass stream to the processEncryptedData service as necessary.

See Also

pub.smime:processEncryptedDatapub.smime:createSignedData

errorCode String Conditional. Number indicating what kind of error occurred, if any, while processing the signature. See errorMessage for possible values.

If no error occurred, errorCode is not returned.

errorMessage String Conditional. Textual error message indicating what kind of error occurred, if any, while processing the signature.

errorCode errorMessage

1 Invalid signer certificate chain file information.

4 Signature cannot be verified.

5 Expired certificate chain.

6 Error in certificate chain.

7 Untrusted certificate.


C H A P T E R17
PRT Folder
You use the elements in the prt folder to work with the process run-time system.


C H A P T E R 1 7 P R T F o l d e r



pub.prt:CorrelationService WmPRT. Specification that describes the inputs and outputs required for a correlation service.

pub.prt:ProcessData WmPRT. Document type that describes the structure of the ProcessData section of the pipeline for a process.

pub.prt.admin:changeProcessStatus WmPRT. Terminates the process by broadcasting a request to all servers participating in the process to change the process status.

pub.prt.admin:deleteProcess WmPRT. Deletes from the Process Tracking Store database the storage information associated with a process, as well as any mappings to correlation IDs.

pub.prt.admin:scanPackage WmPRT. Tells the process run time to scan a specified package for new or updated process model fragments and use these fragments to update its internal model index.

pub.prt.assign:expToProperty WmPRT. Assigns an Xpath expression to a BPEL property.

pub.prt.assign:expToVariable WmPRT. Assigns an Xpath expression to a variable.

pub.prt.assign:literalObjectToProperty WmPRT. Assigns a literal object to a BPEL property.

pub.prt.assign:literalObjectToVariable WmPRT. Assigns a literal object to a global data variable.

pub.prt.assign:literalStringToProperty WmPRT. Assigns a literal string to a BPEL property.

pub.prt.assign:literalStringToVariable WmPRT. Assigns a literal string to a global data variable.

pub.prt.assign:literalToPartner WmPRT. Assigns a literal value (EndPointReference) to a partner.

pub.prt.assign:partnerToPartner WmPRT. Assigns a partner to a partner.

pub.prt.assign:partnerToVariable WmPRT. Assigns a partner to a variable.

pub.prt.assign:propertyToProperty WmPRT. Assigns a property to a property.

pub.prt.assign:propertyToVariable WmPRT. Assigns a property to a variable.

pub.prt.assign:setPartnerAuthentication WmPRT. Sets partner authentication data for dynamic binding.

pub.prt.assign:variableToPartner WmPRT. Assigns a global data variable to a partner.

pub.prt.assign:variableToProperty WmPRT. Assigns a global data variable to a property.

pub.prt.assign:variableToVariable WmPRT. Assigns a variable to a variable.

pub.prt.correlate:deleteCorrelation WmPRT. Deletes all mappings between the specified process instance ID and any correlation IDs or conversation IDs.


pub.prt:CorrelationService

pub.prt :Correlat ionServiceWmPRT. Specification that describes the inputs and outputs required for a correlation service.

A correlation service is associated with one or more steps in a process model. The process run time (PRT) uses the correlation service associated with a step to route IS documents as inputs into that step to a running instance of the model, where appropriate. For more about correlation services, see the webMethods Modeler User’s Guide.

Input Parameters

pub.prt.correlate:establishCorrelation WmPRT. Sets up a correlation between a correlation ID and a process ID or between a conversation ID (for a Trading Networks document) and a process ID.

pub.prt.correlate:lookupCorrelation WmPRT. Returns the process instance ID that is associated with the specified correlation ID or conversation ID. If no association exists, creates a new process instance ID and mapping.

pub.prt.globalData:lockGlobalData WmPRT. Locks process level Global Data for exclusive use for this step.

pub.prt.log:logActivityMessages WmPRT. Logs process activity messages to the IS Core Audit Log database.

pub.prt.tn:deleteByCID WmPRT. Deletes a process instance associated with a given conversation ID.

pub.prt.tn:getPIDforCID WmPRT. Returns the process instance ID for a given conversation ID.

pub.prt.tn:getRoleInfo WmPRT. Fetches role information for a specified role in process.

pub.prt.tn:handleBizDoc WmPRT. Sends a Trading Networks BizDocEnvelope (Trading Networks document) to the process run time, to allow the document to be processed as part of a business process.

pub.prt.tn:mapCIDtoPID WmPRT. Sets up a mapping between the specified conversation ID and process instance ID.

pub.prt.tn:RoleInfo WmPRT. Document type that describes information maintained for roles in a process.


ProcessModelID String ID of the process model with which this invocation of the correlation service is involved (for example, P100099FF3).

Because a single correlation service can be associated with steps from more than one process model, you can use the ProcessModelID to identify the process model using the correlation service at run time.



Output Parameters

pub.prt :ProcessDataWmPRT. Document type that describes the structure of the ProcessData section of the pipeline for a process.

This pipeline is automatically filled in by the process run time for every step of a process. The service for that step is executed with this data.

Parameters

LogicalServer String Name of the logical server that is associated with the step in the process model with which this invocation of the correlation service is involved. In other words, the name of the logical server on which this correlation service is running (for example, Design_Server).

Because a single correlation service can be used with steps that execute on different servers, you can use LogicalServer to identify the specific server at run time.

ProcessStepID String ID of the step in the process model with which this invocation of the correlation service is involved (for example, N3).

Because a single correlation service can be associated with multiple steps in a process model, you can use ProcessStepID to identify the specific step at run time.

DocumentName String Name of this document as used in the process model (for example, “OrderDocument”).

DocumentType String Name of this document type (for example, “orders.sap:OrderDocument”).

Document Document The document.

ProcessCorrelationID String Conditional. An abstract ID that correlates to the actual process instance ID of the running process. For example: “CUSTOMER-0003456977::ORDER-19477593-AR9-1000”. All documents bound for the same instance of the process must return the same correlation ID. Similarly, correlation IDs must be unique across all process instances.

CorrelateAsTN String Conditional. Flag that indicates whether the correlation ID in ProcessCorrelationID is a conversation ID.


true ProcessCorrelationID is a Trading Networks conversation ID.

false Default. ProcessCorrelationID is not a Trading Networks conversation ID.

ProcessInstanceID String Process instance ID of the running process.


pub.prt.admin:changeProcessStatus

See Also

pub.prt.tn:RoleInfo

pub.prt .admin:changeProcessStatusWmPRT. Terminates the process by broadcasting a request to all servers participating in the process to change the process status.

Input Parameters

Output Parameters

None.

Note: If this service runs to completion, it means that the request for a status change has been made. The servers involved handle these requests asynchronously. You can track the status of a process using webMethods Monitor.

ProcessIteration String Number of times the process has been restarted (that is, iteration count).

ProcessModelID String Model ID of the process model that the running process is using.

ProcessStepID String Step ID of the running step in the process.

LogicalServer String Name of the logical server on which the running step was assigned and is executing.

TryCount String The current iteration of the step.

Roles Document Conditional. If this process involves Trading Networks, this will contain information about the roles in the process. The key will be the role name, and the value will be an instance of the pub.prt.tn:RoleInfo IS document type.

ProcessInstanceID String ID of the process instance that you want to terminate.

ProcessIteration String The iteration of the process instance that you want to terminate.

ProcessModelID String Optional. ID of the process model (ModelID) associated with the process you want to terminate.

Action String Termination code that is to be broadcast. Indicates how the process was terminated.

Set to... To...

CANCEL Quit with a status of “cancelled”, indicating that the process was intentionally terminated.

FAIL Indicate that some abnormal error condition dictates that the process must terminate.



Usage Notes

The most typical use of this service is to “fail” a process after handling some unexpected error.

pub.prt .admin:deleteProcessWmPRT. Deletes from the Process Tracking Store database the storage information associated with a process, as well as any mappings to correlation IDs.

The system automatically deletes most storage information when the process has finished running, but it does not delete correlation and conversation IDs. These must be deleted manually using this service. In general, you should not delete these IDs unless you want to re-use them across processes. However, webMethods strongly recommends that each ID be unique, and thus that you not re-use them across processes.

Input Parameters

Output Parameters

Usage Notes

Using this service to delete storage information for a running process will produce unpredictable results.

See Also

pub.prt.tn:deleteByCID

pub.prt .admin:scanPackageWmPRT. Tells the process run time to scan a specified package for new or updated process model fragments and use these fragments to update its internal model index.

This service updates the process run time index as follows:

If a fragment file is new, scanPackage adds information from this file to the process run time index.

If a fragment file is modified, scanPackage replaces existing index information to reflect the modifications.

ProcessInstanceID String ID of the process instance for which you want to delete storage information.

success String Flag indicating whether the process storage information was deleted.


true The process storage information was deleted.

false The process storage information was not deleted.


pub.prt.assign:expToProperty

If a fragment file no longer exists, scanPackage deletes the corresponding index information.

Input Parameters

Output Parameters

Usage Notes

Use this service before or after replicating a package that contains PRT process model fragments to accomplish the following:

After unzipping a package onto a new server but before enabling it, invoke this service to force the PRT to pick up the new fragments.

After disabling all related process models, zipping a package, and deleting the package from an old server, invoke this service to force the PRT to discard information about the old model.

pub.prt .assign:expToPropertyWmPRT. Assigns an Xpath expression to a BPEL property.

Input Parameters

Usage Notes

For all the services copying a source of exp, note the following:

The BPEL built-in XPath functions bpws:getVariableProperty, bpws:getVariableData, and bpws:getLinkStatus are supported.

Package String Name of the package that you want to scan. If the named package does not exist on the Integration Server, information about any fragments previously loaded from that package will be deleted from the PRT model index.

ExistingFragments String List Conditional. Number of fragments contained in the package that were already known to the PRT.

ModifiedFragments String List Conditional. Number of fragments contained in the package that had been modified since the PRT last read them.

MissingFragments String List Conditional. Number of fragments contained in the package that have been deleted since the PRT last read them.

NewFragments String List Conditional. Number of fragments contained in the package that are new since the PRT last scanned the named package.

expFrom String Xpath expression or function.

variableNameTo String Variable name in global data.

property String BPEL property associated with the message type for this variable.



Standard XPath functions, as defined in the XPath spec, are supported.

Namespaces are not supported.

pub.prt .assign:expToVariableWmPRT. Assigns an Xpath expression to a variable.

Input Parameters

Usage Notes

For all the services copying a source of exp, note the following:

BPEL built-in XPath functions bpws:getVariableProperty, bpws:getVariableData, and bpws:getLinkStatus are supported.

Standard XPath functions, as defined in the XPath spec, are supported.

Namespaces are not supported.

The following applies to using partTo and queryTo:

You can either specify the part name or query the actual data.

queryTo requires a forward slash ( / ) before the variable.

pub.prt .assign: l i teralObjectToPropertyWmPRT. Assigns a literal object to a BPEL property.

Input Parameters

expFrom String Xpath expression or function.


partTo String Optional. First level of data in the WSDL description.

queryTo String Optional. Exact value in nested data.

value Object A complex data structure (for example, an array), to assign to a BPEL property.


propertyTo String BPEL property associated with the message type for this variable.


pub.prt.assign:literalObjectToVariable

pub.prt .assign: l i teralObjectToVariableWmPRT. Assigns a literal object to a global data variable.

Input Parameters

Usage Notes




pub.prt .assign: l i teralStr ingToPropertyWmPRT. Assigns a literal string to a BPEL property.

Input Parameters

pub.prt .assign: l i teralStr ingToVariableWmPRT. Assigns a literal string to a global data variable.

Input Parameters

value Object Literal object to assign to a global data variable.




value String Literal string to assign.



value String Literal string to assign.






Usage Notes




pub.prt .assign: l i teralToPartnerWmPRT. Assigns a literal value (EndPointReference) to a partner.

Input Parameters

value (EndPointReference)

address String The actual network address for a Web service endpoint, formatted as a URI. For example, if the Web service is running at http://66.28.98.121:9090/soap, you would need to specify this string as its address.

portType String An abstract set of operations supported by one or more Web service endpoints and their associated messages. This grouping is specified by the WSDL. This is used to specify the set of operations which contains the operation to be invoked.

operations Document List A list of Web service actions (or methods) supported by the Web service. A Web service can have one or more operations, and this is structured as a list of documents. There is one operation document for each of the service operations in the binding.

namespaceName String The namespace of the service to which the operation belongs.

localName String The logical name of the method. Together with namespaceName, it provides the qualified name of the operation.

service Document A document containing a single field, soapAction.

soapAction String The actual name of the Web service operation's underlying method. This is supplied in the SOAPAction header field of the SOAP message. This need not be supplied for Web services generated by the Integration Server, but is usually required by external Web services.


pub.prt.assign:partnerToPartner

pub.prt .assign:partnerToPartnerWmPRT. Assigns a partner to a partner.

Input Parameters

pub.prt .assign:partnerToVariableWmPRT. Assigns a partner to a variable.

Input Parameters

auth Document A set of authentication credentials for the Integration Server. This builds an identity with which the Integration Server SOAP services are run. This is specific to Integration Server and does not represent any data from the WSDL. For example, to invoke a Web service from Integration Server using the 'OPER' identity, which has username 'oper' and password 'oper123', you would specify 'basic' for type (that is, basic password authentication), 'oper' for user and 'oper123' for pass.

type String The type of authentication mechanism.

user String The user name to be used for authentication.

pass String The password associated with the user name.

binding Document The SOAP binding information as specified for the Web service interaction the EndpointReference represents.

soapStyle String The type of SOAP service binding to be made (for example, RPC, Message, HTTP-GET, HTTP-POST). Note only the RPC style is supported.

soapTransport String The underlying transport to be used.

partnerTo String Partner data for the assign step.

partnerFrom String Partner data for the assign step.

roleFrom String Role data for the assign step.


partnerFrom String Partner data for the assign step.

roleFrom String Role data for the assign step.



Usage Notes




pub.prt .assign:propertyToPropertyWmPRT. Assigns a property to a property.

Input Parameters

pub.prt .assign:propertyToVariableWmPRT. Assigns a property to a variable.

Input Parameters

Usage Notes







variableNameFrom String Variable name in global data.

propertyFrom String BPEL property associated with the message type for this variable.




propertyFrom String BPEL property associated with the message type for this variable.





pub.prt.assign:setPartnerAuthentication

pub.prt .assign:setPartnerAuthenticat ionWmPRT. Sets partner authentication data for dynamic binding.

Input Parameters

Usage Notes

Use this service for dynamic binding of assign data.

For static binding, use pub.prt.assign:literalToPartner.

pub.prt .assign:variableToPartnerWmPRT. Assigns a global data variable to a partner.

Input Parameters

Usage Notes

The following applies to using partFrom and queryFrom:


queryFrom requires a forward slash ( / ) before the variable.

value (Authentication)

type String The type of authentication mechanism.

user String The user name to be used for authentication.

pass String The password associated with the user name.



partFrom String Optional. First level of data in the WSDL description.

queryFrom String Optional. Exact value in nested data.

partnerTo String Defines partner for the assign step.



pub.prt .assign:variableToPropertyWmPRT. Assigns a global data variable to a property.

Input Parameters

Usage Notes

The following applies to using partFrom and queryFrom:


queryFrom requires a forward slash ( / ) before the variable.

pub.prt .assign:variableToVariableWmPRT. Assigns a variable to a variable.

Input Parameters

Usage Notes

The following applies to using partFrom and queryFrom and partTo and queryTo:


queryFrom and queryTo require a forward slash ( / ) before the variable.













pub.prt.correlate:deleteCorrelation

pub.prt .correlate:deleteCorrelat ionWmPRT. Deletes all mappings between the specified process instance ID and any correlation IDs or conversation IDs.

Input Parameters

Output Parameters

Usage Notes

Use this service with care. Deleting correlation mappings for running process instances could have unpredictable results.

pub.prt .correlate:establ ishCorrelat ionWmPRT. Sets up a correlation between a correlation ID and a process ID or between a conversation ID (for a Trading Networks document) and a process ID.

Input Parameters

Output Parameters

ProcessInstanceID String Process instance ID for the mapping(s) you want to delete.

success String Flag indicating whether any mappings were deleted.


true One or more mappings were deleted.

false No mappings were deleted.

ProcessCorrelationID String The correlation ID or conversation ID that you want to map to the specified process instance ID.

ProcessInstanceID String Process instance ID that you want to map to the specified correlation ID or conversation ID.

MappingType String Optional. Flag indicating the type of ID that you supplied.


IS Default. This is a correlation ID.

TN This is a Trading Networks conversation ID.

success String Flag indicating whether the mapping took place.



Usage Notes

The process run time automatically establishes these mappings when Trading Networks or IS documents are used to start processes, or when a Trading Networks document is output from a running process. Use this service when there is no way for the process run time to determine the mapping itself (for example, when a process starts with an IS document and then waits for a Trading Networks document).

Use this service with care. Be sure to create correct mappings; an invalid mapping could prevent other processes from completing successfully.

pub.prt .correlate: lookupCorrelat ionWmPRT. Returns the process instance ID that is associated with the specified correlation ID or conversation ID. If no association exists, creates a new process instance ID and mapping.

Input Parameters


true The mapping was successfully established.

false The mapping could not be established.

ProcessCorrelationID String Correlation ID or conversation ID for which you want to return the process instance ID.

MappingType String Optional. Flag indicating whether ProcessCorrelationID specifies a correlation ID or a conversation ID.


IS Default. ProcessCorrelationID is a correlation ID for an IS document.

TN ProcessCorrelationID is a Trading Networks conversation ID for a Trading Networks document.

CreateIfMissing String Optional. Flag indicating whether you want a mapping to be created if none is found.

Set to... To...

true Create a new process instance ID and mapping if none is found.

false Default. Take no action if the mapping is not found.


pub.prt.globalData:lockGlobalData

Output Parameters

Usage Notes

Use this service to check on mappings that were established with previous calls to pub.prt.correlate:establishCorrelation or, under certain circumstances, to check on the existence of a process with a particular correlation ID or conversation ID.

See Also

pub.prt.correlate:establishCorrelation

pub.prt .globalData: lockGlobalDataWmPRT. Locks process level Global Data for exclusive use for this step.

Input Parameters

Output Parameters

ProcessInstanceID String Conditional. The process instance ID mapped to the specified correlation ID or conversation ID (if any).

Created String Conditional. Flag that indicates whether the process instance ID in ProcessInstanceID was created by this service invocation because you specified true for CreateIfMissing.


true This process instance ID was created by this service invocation.

false This process instance ID was already mapped to the specified correlation ID or conversation ID.

success String Flag indicating whether a process instance ID was returned.


true A process instance ID was found or created and returned.

false A process instance ID was not returned because the correlation ID or conversation ID was not established.

ProcessInstanceID String Process instance ID for the mapping(s) you want to delete.

ProcessIteration String Process iteration, expressed as a number.

ProcessStepID String Step ID as defined in Modeler.

success String Indicates the service executed successfully

globalDataLock String Handle to lock object and not drop from pipeline.



Usage Notes

Use this service as a first service in the Assign Step.

pub.prt . log: logActivi tyMessagesWmPRT. Logs process activity messages to the IS Core Audit Log database.

Input Parameters

Output Parameters

None.

Usage Notes

This service can be added either to the flow service generated for a process step or to services called within that step. The service logs the input parameters to the WMSERVICEACTIVITYLOG log file in the IS Core Audit Log database. Logged activity messages can be viewed in webMethods Monitor on the Process Instance Status and Service Details pages. For more information about viewing activity messages in webMethods Monitor, see the webMethods Monitor User’s Guide.

pub.prt . tn:deleteByCIDWmPRT. Deletes a process instance associated with a given conversation ID.

Use this service to delete process state for processes that involve webMethods Trading Networks and for which you have a conversation ID rather than a process ID.

FullMessage String Optional. Complete message to record in the IS Core Audit Log database. The message can be up to 1024 bytes.

BriefMessage String Optional. Shortened version of the full message. The message can be up to 240 bytes.

EntryType String Flag indicating the type of message.

Set to... To...

Message Indicate that the message is informational and no action is needed.

Warning Indicate that the message is a warning message. The process can complete successfully even if the circumstance causing the warning is not addressed.

Error Default. Indicate that the message is an error message. The process cannot complete successfully until the circumstance causing the error is resolved.


pub.prt.tn:getPIDforCID

Input Parameters

Output Parameters

Usage Notes

This service invokes pub.prt.correlate:lookupCorrelation to look up the mapped ProcessInstanceID and invokes pub.prt.admin:deleteProcess to delete the process state information.

Using this service to delete state of a running process will produce unpredictable results.

See Also

pub.prt.admin:deleteProcess

pub.prt . tn:getPIDforCIDWmPRT. Returns the process instance ID for a given conversation ID.

Use this service within a process that involves webMethods Trading Networks when you have a conversation ID but need the corresponding process instance ID. This service is a wrapper around pub.prt.correlate:lookupCorrelation.

Input Parameters

Output Parameters

ConversationID String Conversation ID for the process instance for which you want to delete process state information.

success String Flag indicating whether the process state was deleted.


true The process state was deleted.

false The process state was not deleted.

ConversationID String Conversation ID for which you want the associated process instance ID.

ProcessInstanceID String Conditional. The process instance ID related to the specified conversation ID (if there is one).

success String Flag indicating whether the process ID was retrieved.


true The process ID was retrieved.

false The process ID was not retrieved.



See Also

pub.prt.tn:mapCIDtoPID

pub.prt . tn:getRoleInfoWmPRT. Fetches role information for a specified role in process.

Use this service within processes that involve webMethods Trading Networks.

The returned information includes the internal ID of the partner within the Trading Networks system, which you can use to retrieve the Trading Networks profile information.

Input Parameters

Output Parameters

See Also

pub.prt.tn:RoleInfopub.prt:ProcessData

pub.prt . tn:handleBizDocWmPRT. Sends a Trading Networks BizDocEnvelope (Trading Networks document) to the process run time, to allow the document to be processed as part of a business process.

Input Parameters

ProcessData Document The ProcessData portion of the pipeline, which is standard information available for all processes. The structure of this document (IData object) is defined by pub.prt:ProcessData.

roleName String Name of the role for which you want to retrieve information.

roleInfo Document Conditional. Role information that is currently available for the specified role. The structure of this document (IData object) is defined by pub.prt.tn:RoleInfo. This parameter is not present if no documents have been sent to or received for this role.

bizdoc com.wm.app.tn.doc.BizDocEnvelope Trading Networks BizDocEnvelope document that you want to send to the process run time.

ConversationID String Optional. Conversation ID for the document. Specify ConversationID if the document has no conversation ID or if you want to use an alternate conversation ID.


pub.prt.tn:mapCIDtoPID

Output Parameters

None.

Usage Notes

Trading Networks automatically sends documents to the process run time if it extracts a conversation ID from the document. If you did not have Trading Networks extract a conversation ID, you can use this service to supply a conversation ID and send the document to the process run time to be processed as part of a business process.

pub.prt . tn:mapCIDtoPIDWmPRT. Sets up a mapping between the specified conversation ID and process instance ID.

This service is a wrapper around pub.prt.correlate:establishCorrelation.

Input Parameters

Output Parameters

Note: If this service runs to completion, the mapping has been established.

ProcessModelID String Optional. ID of the process model that you want the process run time to use to process the document. Specifying ProcessModelID overrides the normal process of matching a document to a process model.

prtIgnoreDocument String Optional. A flag indicating whether this document is to be ignored or processed by the process run time.

Set to... To...

true Ignore the document and not send it to the process run time for processing. Setting the flag to true causes this service to do nothing.

false Send the document to the process run time for processing.

ConversationID String Conversation ID that you want to map to the specified process instance ID.

ProcessInstanceID String Process instance ID that you want to map to the specified conversation ID.

success String Flag indicating whether the mapping was established.


true The mapping was established.

false The mapping was not established.



Usage Notes

The process run time automatically establishes this mapping when a Trading Networks document (bizdoc) is used to start a process or is modeled as an output from a process step. Use this service when there is no way for the process run time to determine the mapping itself (for example, when a process is started with a non-Trading Networks document and later waits for a Trading Networks document).

Use this service with care. Be sure to create correct conversation ID to process instance ID mappings; an invalid mapping could prevent other processes from completing successfully.

See Also

pub.prt.tn:getPIDforCID

pub.prt . tn:RoleInfoWmPRT. Document type that describes information maintained for roles in a process.

Parameters

ProfileID String Trading Networks internal ID of this trading partner.

String Corporation name that is specified in the Trading Networks profile for this trading partner.

CorporationName

OrgUnitName String Organizational unit name that is specified in the Trading Networks profile for this trading partner.

Type String The type of software the partner uses to connect to the trading network.


TNServer The partner is using webMethods Trading Networks.

TNPartner The partner is using webMethods for Partners.

Browser The partner is using a Web browser.

TNPartner The partner is using some other method.

Status String Status (active or inactive) of the Trading Networks profile for this trading partner.

PreferredProtocol String The delivery protocol that the partner prefers you to use when sending documents to it.


ftp1 The partner prefers documents sent using the primary FTP protocol.

ftp2 The partner prefers documents sent using the secondary FTP protocol.


pub.prt.tn:RoleInfo

http1 The partner prefers documents sent using the primary HTTP protocol.

http2 The partner prefers documents sent using the secondary HTTP protocol.

https1 The partner prefers documents sent using the primary HTTPS protocol.

https2 The partner prefers documents sent using the secondary HTTPS protocol.

smtp1 The partner prefers documents sent using the primary e-mail protocol.

smtp2 The partner prefers documents sent using the secondary e-mail protocol.

null The partner prefers documents sent using the polling protocol.

LastSendingLocale String Locale associated with the last transmission from this trading partner. Whenever a document is received from this trading partner, this field is updated with the locale information specified in the transmission. For example, if the trading partner uses HTTP to post an XML document to a Trading Networks server and specifies the “ja_JA” locale in the HTTP transmission, this field will contain ja_JA.


C H A P T E R18
Publish Folder
You use the elements in the publish folder to publish documents to the integration platform’s messaging facility.


C H A P T E R 1 8 P u b l i s h F o l d e r


pub.publ ish:del iverWmPublic. Delivers a document to a specific destination.

Note: You must be connected to a Broker to use this service.


pub.publish:deliver WmPublic. Delivers a document to a specific destination.

pub.publish:deliverAndWait WmPublic. Requests a reply document from a specific client. The service waits for the reply or indicates that the pub.publish:waitForReply service should retrieve the reply later.

pub.publish:documentResolverSpec WmPublic. Specification for the signature of a service that determines whether a document’s status is New, Duplicate, or In Doubt.

pub.publish:envelope WmPublic. Document type that defines the content and structure of the envelope that accompanies a published document.

pub.publish:getRedeliveryCount WmPublic. Retrieves the redelivery count for a document.

pub.publish:publish WmPublic. Publishes a document locally or to the Broker.

pub.publish:publishAndWait WmPublic. Broadcasts a request for a document from any client subscribed to a specific document type. The service waits for the reply or indicates that the pub.publish:waitForReply service should retrieve the reply later.

pub.publish:reply WmPublic. Delivers a reply document to the requesting client.

pub.publish:waitForReply WmPublic. Retrieves the reply for an asynchronous request. If a reply is not available, the Integration Server continues to wait for the document until the time specified in the waitTime parameter of the pub.publish:deliverAndWait or pub.publish:publishAndWait service elapses.

pub.publish.notification:error WmPublic. Publishable document type that defines the document that is delivered when a trigger encounters an error or exception condition.


pub.publish:deliver

Input Parameters

Output Parameters

None.

Usage Notes

To view a list of client IDs on the Broker, use the Broker Administrator or use Developer to test the publishable document type that you want to deliver.

For more information about how the Integration Server and Broker deliver documents and for information about building a service that delivers a document, see the Publish-Subscribe Developer’s Guide.

See Also

pub.publish:publishpub.publish:deliverAndWaitpub.publish:envelope

documentTypeName String Fully qualified name of the publishable document type being delivered.

The publishable document type must be synchronized with the associated Broker document type. If the document types are not synchronized, publication fails.

document Document Document (IData object) conforming to the publishable document type in documentTypeName.

destId String The client ID to which the document will be delivered. You can specify the default client ID for an Integration Server, or you can specify the client ID for an individual trigger. If you specify an incorrect client ID, the Integration Server delivers the document to the Broker, but the Broker never delivers the document to the intended recipient and no error is produced.

delayUntilServiceSuccess String Optional. Flag indicating whether the Integration Server should publish the document when the pub.publish:deliver service executes or after the top-level service successfully completes. If the top-level service fails, the Integration Server will not publish the document.

Set to... To...

true Delay publishing until after the top-level service executes successfully.

false Default. Publish the document when the pub.publish:deliver service executes.



pub.publ ish:del iverAndWaitWmPublic. Requests a reply document from a specific client. The service waits for the reply or indicates that the pub.publish:waitForReply service should retrieve the reply later.

Note: You must be connected to a Broker to use this service.

Input Parameters

documentTypeName String Fully qualified name of the publishable document type being delivered.

Note: The publishable document type must be synchronized with the associated Broker document type. If the document types are not synchronized, publication fails.

document Document Document (IData object) conforming to the publishable document type in documentTypeName.

receiveDocumentTypeName String Optional. Fully qualified name of the publishable document type expected as a reply. If no value is specified, the service uses the first reply document of any type it receives, as long as the value of tag in the envelope of the reply document matches the tag in the envelope of the published document. All other reply documents are discarded.

destId String The client ID to which the document will be delivered. You can specify the default client ID for an Integration Server, or you can specify the client ID for an individual trigger. If you specify an incorrect client ID, the Integration Server delivers the document to the Broker, but the Broker never delivers the document to the intended recipient and no error is produced.

waitTime String Optional. Specifies the time to wait (in milliseconds) for the response to arrive. If no value is specified, the service waits indefinitely until it receives a reply.

async String Optional. Flag specifying whether this is an asynchronous or synchronous request/reply.

Set to... To...


pub.publish:deliverAndWait

Output Parameters

Usage Notes

You can use the pub.publish:deliverAndWait service to initiate and continue a private conversation between two Broker clients. This is a variation of the request/reply model. One client executes a service that delivers a document to a specific client. This document requests information from the receiving client.

In a synchronous request/reply, the delivering service stops executing while it waits for a response. When the service receives a reply document from the specified client, the servers resumes executing. If the waitTime elapses before the service receives a reply, the Integration Server ends the request, and the service returns a null document indicating that the request timed out. The Integration Server then executes the next step in the flow service. If a reply document arrives after the flow service resumes execution, the Integration Server rejects the document and

true Indicate that this is an asynchronous request/reply. After publishing the document, the Integration Server executes the next step in the flow service immediately. The Integration Server does not wait for a reply before continuing service execution.

Note: To retrieve the reply to an asynchronous request, invoke the pub.publish:waitForReply service.

false Default. Indicate that this is a synchronous request/reply. After publishing the document, the Integration Server waits for a reply before executing the next step in the flow service.

receivedDocument Document A Document (IData object) received as reply.

Important! The Integration Server treats all reply documents as volatile documents. If the Integration Server shuts down before processing the reply document, the reply document is lost.

tag String Conditional. A unique identifier for a deliver request. The Integration Server uses the tag value to match the requesting document with its corresponding reply document.

The service produces a tag output value only when the async field is set to true. The tag value is required input when using the pub.publish:waitForReply service to retrieve the reply.

Note: The tag output value is the same value that the Integration Server places in the tag field of the request document’s envelope.



creates a journal log message stating that the document was rejected because there is no service thread waiting for the document.

In an asynchronous request/reply, the delivering service continues executing the steps in the service after publishing the document. To retrieve the reply, the delivering service must invoke the pub.publish:waitForReply service. If the wait time elapses before the pub.publish:waitForReply service receives a document, the pub.publish:waitForReply service returns a null document indicating that the request timed out.

A service that contains multiple asynchronous deliver requests allows the service to deliver all the requests before collecting the replies. This approach can be more efficient than delivering a request, waiting for a reply, and then delivering the next request.

If you create a service that contains multiple asynchronous requests, make sure to link the tag output to another field in the pipeline. Each asynchronous delivery produces a tag field in the pipeline. If the tag field is not linked to another field, the next asynchronous delivery request (that is, the next execution of the pub.publish:deliverAndWait service) will overwrite the first tag value.

To view a list of client IDs on the Broker, use the Broker Administrator or use Developer to test the publishable document type that you want to deliver.

Use pub.publish:deliverAndWait if you need to know that a specific client successfully received and processed the request document.

For more information about how to build a services that initiate synchronous or asynchronous request/reply scenarios, see the Publish-Subscribe Developer’s Guide.

See Also

pub.publish:waitForReplypub.publish:publishAndWaitpub.publish:replypub.publish:envelope

pub.publ ish:documentResolverSpecWmPublic. Specification for the signature of a service that determines whether a document’s status is New, Duplicate, or In Doubt.

Input Parameters

documentTypeName String Fully qualified name of the document whose status is In Doubt.

redeliveryCount String Number of times the document has been redelivered to the trigger queue on the Integration Server.

uuid String Universally unique identifier for the document. The publishing application assigns the uuid to a document.


pub.publish:envelope

Output Parameters

Usage Notes

The pub.publish:documentResolverSpec must be used as the signature for any service used to resolve the processing status of a document. For information about building a document resolver service and enabling exactly once processing for a trigger, see the Publish-Subscribe Developer’s Guide.

pub.publ ish:envelopeWmPublic. Document type that defines the content and structure of the envelope that accompanies a published document.

The envelope records information such as the sender’s address, the time the document was sent, password and certificate information, and other useful information for routing and control. Every publishable document type contains a document reference to this document type.

document Document The document (IData object) whose status needs to be resolved. This document must conform to the publishable document type specified in documentTypeName.

transport String The transport (such as LOCAL or BROKER) used to send the document to the Integration Server.

status String Indicates the status of the document. The value of this field determines whether the Integration Server processes the document, discards the document, or sends the document to the audit log. The status field must have one of the following values.

Key Description

NEW Indicates the document is new and has not been processed by the trigger. The Integration Server instructs the trigger to process the document.

DUPLICATE Indicates the document is a duplicate of one already processed by the trigger. The Integration Server discards the document and generates a journal log message.

IN_DOUBT Indicates the status of the document is still in doubt. The document resolver service could not conclusively determine whether the trigger already processed the document. If the audit log is a database, the audit subsystem logs the document and the Integration Server generates a journal log message.

message String Conditional. A user-specified string that indicates why the document status is DUPLICATE or IN_DOUBT. The Integration Server writes the message to the journal log when the server discards the document or routes it to the audit log.



Read/Write Parameters

You can set the following parameters within your service.

activation String Optional. A unique identifier that any Broker client (including the Integration Server) assigns to all documents published as a result of the one-time execution of the integration solution. If a document does not have an activation ID, the Integration Server assigns one when the document is published.

If you are using a trigger to join documents published by different services, you must explicitly set the activation ID of the documents. The services that publish the documents must assign the same activation ID to the documents.

appLastSeqn java.lang.Integer Optional. This field is provided for backward compatibility.

appPassword String Optional. The password of the user specified in appUserName. If the resource that processes the document requires authentication before it begins processing, specify the password in this field.

appSeqn java.lang.Integer Optional. This field is provided for backward compatibility.

appUserName String Optional. The user name for logging into the application that processes the document. Use the appPassword field to specify the password for this user name.

businessContext String Optional. Used by the Integration Server to track business process context and audit context across multiple Integration Servers.

Important! The businessContext field is reserved for internal use by the webMethods Integration Platform. Do not set or overwrite the value of the businessContext field.

controlLabel java.lang.Short[ ] Optional. This field is provided for backward compatibility.

errorsTo String Optional. The client ID to which the Integration Server sends an error notification document if errors occur during document processing by subscribers. If this parameter is not set, error notifications will be sent to the document publisher. The errors document is an instance of pub.publish.notification:error.

errorRequestsTo String Optional. This field is provided for backward compatibility.

locale String Optional. Locale of the publishing client expressed as a URN (Uniform Resource Name). Trigger services examine the locale value to determine the locale to use when processing the document. If the locale field is empty, the locale of the current Integration Server is used instead.

maxResults java.lang.Integer Optional. This field is provided for backward compatibility.

replyTo String Optional. The client ID to which the replies to the published document should be sent. If this parameter is not set, replies will be sent to the document publisher as specified in pubId.

runLevel java.lang.Integer Optional. This field is provided for backward compatibility.

signature byte[ ] Optional. A byte sequence that holds a digital signature. Specify a digital signature if clients receiving this document requires one.



Read-only Parameters

The Broker or Integration Server set the following parameters. You cannot set these parameters within your service, but you can retrieve their values.

signatureType String Optional. The type of digital signature being used.

startResult java.lang.Integer Optional. This field is provided for backward compatibility.

tag java.lang.Integer Optional. Used with pub.publish:publishAndWait and pub.publish:deliverAndWait to match a request document with its corresponding reply document.

Important! The tag field is reserved for internal use by the webMethods Integration Platform. Do not set or overwrite the value of the tag field in the envelope.

trackId String Optional. A unique identifier assigned to a published document by the publishing client application. The Integration Server populates this field with the value of the uuid field.

Important! The trackID field is reserved for internal use by the webMethods Integration Platform. Do not set or overwrite the value of the trackID field.

transactionId String Optional. This field is provided for backwards compatibility.

transformState String Optional. An indication of a document’s current state, set by a publishing client application that transforms data. For example, a client could publish a document with a transformState value of “USEnglish” and a receiving client could translate the document into French and publish it with a transformState value of “French.”

age java.lang.Integer Optional. The cumulative time, in seconds, that the document spends on all Brokers. The Broker starts tracking the document age when it receives the document from the publishing client. The Broker stops tracking the document age when the subscribing client removes the document from the client queue. If the document is routed to successive Brokers, age also includes the length of time the document spends on the other Brokers.

connectionIntegrity String Optional. An indication of whether the received document passed over a link that is not secure. This field can have one of the following values:

Key Description

<empty> At some point, the document passed through a connection that was not encrypted.

U.S Export All the connections used to transport the event had an encryption strength of ENCRYPT_LEVEL_US_EXPORT or greater.

U.S. Domestic The event traveled exclusively over connections with an encryption strength of ENCRYPT_LEVEL_US_DOMESTIC.



destId String Optional. The ID of the client to which the document is being delivered. The publishing client sets the destID when it publishes the document. For example, the Integration Server uses the destID value specified in the pub.publish:deliver service or the pub.publish:deliverAndWait service to populate the destID value in the document envelope

enqueueTime java.util.Date Optional. The date and time that the Broker placed the document into the client queue.

logBroker String Optional. The name of the Broker that contains the document in its document log. The Broker sets this parameter when Broker-based document logging and the logging utility are enabled.

logHost String Optional. The host name and port number of the Broker that contains the document in its document log. The Broker sets this parameter when Broker-based document logging and the logging utility are enabled.

pubDistinguishedName String Optional. The distinguished name of the publisher’s SSL certificate. The Broker sets this parameter when the publisher has an SSL connection to the Broker and clears this parameter when the publisher has a non-SSL connection.

pubId String Optional. The client ID of the document’s publisher. If the publishing client is connected to a different Broker than the recipient, the Broker uses the fully qualified client ID (that is, the Broker prefixes the client ID with the name of the publisher’s Broker). You can use the Integration Server Administrator to view the client ID for an Integration Server. You can use the Broker Administrator to view the client IDs for all clients connected to a Broker.

pubNetAddr byte[ ] Optional. The IP address and port number of the document’s publisher.

pubSeqn java.lang.Long Optional. This field is provided for backwards compatibility.

pubLabel java.lang.Short[ ] Optional. This field is provided for backwards compatibility.

recvTime java.util.Date Optional. The date and time the document was received by the Broker.

route Document List Optional. Information about the Brokers through which a document passed. When a Broker receives a document, the Broker sets the broker and recvTime keys. When the Broker places the document in the queue for the next Broker, the first Broker sets enqueueTime. The Broker only sets these fields when document is forwarded from one Broker to another. The Broker does not set these fields when the publishing and receiving clients are connected to the same Broker.

Key Description

broker String Optional. The name of the Broker.

recvTime java.util.Date Optional. The time the Broker received the document from the publishing client or another Broker.


pub.publish:getRedeliveryCount

Output Parameters

None.

Usage Notes

For more information about setting and using a document’s envelope parameters, see the webMethods Broker Client Java API Reference Guide, the webMethods Broker Client C API Programmer’s Guide, Publish-Subscribe Developer’s Guide, and the webMethods Developer User’s Guide.

See Also

pub.publish:deliverpub.publish:deliverAndWaitpub.publish:publishpub.publish:publishAndWaitpub.publish:publishAndWaitpub.publish.notification:error

pub.publ ish:getRedel iveryCountWmPublic. Retrieves the redelivery count for a document.

The redelivery count indicates the number of times the document has been redelivered to the trigger queue on the Integration Server. A document is redelivered to a trigger queue if the Integration Server shuts down before processing and acknowledging the document.

Input Parameters

None.

Output Parameters

enqueueTime java.util.Date Optional. The time the Broker placed the document in the queue for the next Broker.

uuid String Optional. Universally unique identifier for the document. The Integration Server assigns the UUID when it publishes the document. The receiving Integration Server uses the UUID to detect duplicate documents.

redeliveryCount String Specifies the number of times the trigger queue on the Integration Server has received the document. The redelivery count can be one of the following:

Value Description



Usage Notes

If you do not want to use the exactly once processing capabilities Developer provides, you can invoke the pub.publish:getRedeliveryCount service within your trigger service. The redelivery count for a document can provide an initial indication of whether the Integration Server has already processed the document.

The Integration Server retrieves the redelivery count for the document currently maintained in the invoke state. That is, the Integration Server retrieves the redelivery count for the document that caused the trigger service to execute.

When a trigger service satisfied by an All (AND) join condition invokes pub.publish:getRedliveryCount, the pub.publish:getRedeliveryCount service returns the redelivery count for the last document received by the join. For example, suppose that documents A and B satisfied an All (AND) join condition. If the Integration Server receives document A first and document B second, when pub.publish:getRedliveryCount executes, it retrieves the redelivery count for document B.

pub.publ ish:publ ishWmPublic. Publishes a document locally or to the Broker.

This service broadcasts the document (that is, distributes the document to all clients that subscribe to it).

Input Parameters

-1 Indicates the transport used to send the document does not maintain a document redelivery count. For example, a document received from a Broker version 6.0.1 has a redelivery count of -1. (Brokers that are version 6.0.1 or earlier do not maintain document redelivery counts.)

The Integration Server document may or may not have received the document before.

0 Indicates the document has been received only once.

> 0 Indicates the number of times document has been redelivered.

documentTypeName String Fully qualified name of the publishable document type being published.

If you intend to publish the document to the Broker, the publishable document type must be in sync with the associated Broker document type. If the document types are not synchronized, publication fails.

document Document Document (IData object) conforming to the document type in documentTypeName.

local String Optional. Flag specifying whether the document is to be published locally or to the Broker.


pub.publish:publish

Output Parameters

None.

Usage Notes

For more information about building a service that publishes a document locally or to the Broker, see the Publish-Subscribe Developer’s Guide.

See Also

pub.publish:deliverpub.publish:publishAndWaitpub.publish:envelope

Set to... To...

true Publish locally (to this Integration Server only).

false Default. Publish to the Broker connected to this Integration Server.

If no Broker is configured for the Integration Server, all publishes become local (that is, the local flag is set implicitly to true).

delayUntilServiceSuccess String Optional. Flag indicating whether the publish should happen when the pub.publish:publish service executes or after the top-level service successfully completes. If the top-level service fails, the Integration Server will not publish the document.

Set to... To...


false Default. Publish the document when the publish service executes.



pub.publ ish:publ ishAndWaitWmPublic. Broadcasts a request for a document from any client subscribed to a specific document type. The service waits for the reply or indicates that the pub.publish:waitForReply service should retrieve the reply later.

Input Parameters

documentTypeName String Fully qualified name of the publishable document type being published.

If you intend to publish the document to the Broker, the publishable document type must be in sync with the associated Broker document type. If the document types are not synchronized, publication fails.

document Document Document (IData object) conforming to the document type in documentTypeName.

receiveDocumentTypeName String Optional. Fully qualified name of the document type expected as a reply. If no value is specified, the service uses the first reply document of any type it receives, as long as the value of tag in the reply document envelope matches the tag in the envelope of the published document. All other reply documents are discarded.

local String Optional. Flag specifying whether the document is to be published locally or to the Broker.

Set to... To...

true Publish locally (to this Integration Server only).

false Default. Publish to the Broker attached to this Integration Server.

If no Broker is configured for the Integration Server, all publishes become local (that is, the local flag is set implicitly to true).

waitTime String Optional. Time to wait (in milliseconds) for the response to arrive. If no value is specified, the service waits indefinitely for a reply.

async String Optional. Flag specifying whether this is an asynchronous or synchronous publish.

Set to... To...


pub.publish:publishAndWait

Output Parameters

Usage Notes

You can use the pub.publish:publishAndWait service to initiate a request/reply. The publishing client broadcasts a request for information. Subscribers to the broadcast document compose and send a reply document that contains the information the publisher requested.

A single publish and wait request might receive many response documents. The Integration Server that made the publish and wait request uses only the first reply document it receives from the Broker. The Integration Server discards all other replies. First is arbitrarily defined. There is no guarantee provided for the order in which the Broker processes incoming replies. If you need a reply document from a specific client, use the pub.publish:deliverAndWait service instead.

true Indicate that this is an asynchronous request/reply. After publishing the document, the Integration Server executes the next step in the flow service immediately. The Integration Server does not wait for a reply before continuing service execution.

Note: To retrieve the reply to an asynchronous publish, invoke the pub.publish:waitForReply service.

false Default. Indicate that this is a synchronous request/reply. After publishing the document, the Integration Server waits for a reply before executing the next step in the flow service.

receivedDocument Document Document (IData object) received as response. If no matching document is received within the wait time, this will be null.


tag String Conditional. A unique identifier for a publish request. The Integration Server uses the tag value to match the request document with its corresponding reply document.

The service produces a tag output value only when the async field is set to true. The tag value is required input when using the pub.publish:waitForReply service to retrieve the reply.

Note: The tag output value is the same value that the Integration Server places in the tag field of the request document’s envelope.



The publishAndWait service can be useful in situations where multiple sources contain the response data. For example, suppose that an enterprise uses one application for managing customer data, another for storing master customer records, and a mainframe system for saving customer lists. Each of these applications could answer a published request for customer data. The publishing service will use the first reply document it receives.

A service can issue a publish and wait request in a synchronous or asynchronous manner.

In a synchronous request/reply, the publishing flow service stops executing while it waits for a response. When the service receives a reply document, the service resumes execution. If the waitTime elapses before the service receives a reply, the Integration Server ends the request, and the service returns a null document that indicates that the request timed out. The Integration Server then executes the next step in the flow service. If a reply document arrives after the flow service resumes execution, the Integration Server rejects the document and creates a journal log message stating that the document was rejected because there was no thread waiting for the document.

In an asynchronous request/reply, the publishing flow service continues executing the steps in the service after publishing the document. To retrieve the reply, the publishing flow service must invoke the pub.publish:waitForReply service. If the wait time elapses before the pub.publish:waitForReply service receives a document, the pub.publish:waitForReply service returns a null document indicating that the request timed out.

A service that contains multiple asynchronous publish and wait invocations allows the service to publish all the requests before collecting the replies. This approach can be more efficient than publishing a request, waiting for a reply, and then publishing the next request.

If you create a service that contains multiple asynchronous requests, make sure to link the tag output to another field in the pipeline. Each asynchronously published request produces a tag field in the pipeline. If the tag field is not linked to another field, the next asynchronously published request (that is, the next execution of the pub.publish:publishAndWait service) will overwrite the first tag value.

For more information about building a service that follows the request/reply model, see the Publish-Subscribe Developer’s Guide.

See Also

pub.publish:waitForReplypub.publish:replypub.publish:envelope

pub.publ ish:replyWmPublic. Delivers a reply document to the requesting client.

If the replyTo envelope parameter is set, the reply document is delivered to that destination; otherwise, the reply document is sent to the client ID of the publisher specified in the envelope’s pubId field. This service also correctly maps the required fields from the request document to the reply document.


pub.publish:reply

Note: All reply documents are volatile documents. If the requesting Integration Server shuts down before processing the reply document, the reply document is lost.

Input Parameters

Output Parameters

None.

Usage Notes

A reply document can be a simple acknowledgment, or it can contain information asked for by the publisher of the request document.

If you are building a service to reply to documents that meet join conditions, keep the following in mind:

All (AND) join conditions. If the replying service executes because two or more documents satisfied an All (AND) join condition, the Integration Server uses the envelope of the last document that satisfied the join condition to determine where to send the reply document. If you want the Integration Server to use the envelope of a different document, link the envelope of that document to receivedDocumentEnvelope. If you want to reply to all documents received as part of an All (AND) join, invoke pub.publish:reply once for each document received and map the envelope from the received document to receivedDocumentEnvelope for each call.

receivedDocumentEnvelope Document Optional. The envelope of the document to which you are replying. By default receivedDocumentEnvelope specifies the envelope of the document that triggered this service. (In case of a join, it will specify the last document that satisfied the join condition.) However, you may specify the envelope of any published document to which you want to reply.

documentTypeName String Fully qualified name of the publishable document type for the document that you are sending as a reply. Keep in mind that the publisher of the requesting document might be expecting a reply document that conforms to specific publishable document type.

document Document The reply IData object. This document must conform to the publishable document type specified in documentTypeName.

delayUntilServiceSuccess String Optional. Flag indicating whether the Integration Server should publish the document when the pub.publish:reply service executes or after the top-level service successfully completes. If the top-level service fails, the Integration Server will not publish the document.

Set to... To...


false Default. Publish the document when the publish service executes.



Any (OR) or Only one (XOR) join conditions. If the replying service executes because a document satisfied an Any (OR) or Only one (XOR) join condition, do not map or assign a value to receivedDocumentEnvelope. It is impossible to know which document in the Any (OR) or Only one (XOR) join will be received first. For example, suppose that an Only one (XOR) join condition specified document types A and B. The Integration Server uses the envelope of the document it received first as the receivedDocumentEnvelope value. If you map the envelope of document A to receivedDocumentEnvelope, but the Integration Server receives document B first, your replying service will fail.

Important! Services that publish or deliver a document and wait for a reply can specify a publishable document type to which reply documents must conform. If the reply document is not of the type specified in the receiveDocumentTypeName parameter of the pub.publish:publishAndWait or pub.publish:deliverAndWait service, the publishing service will wait forever for a reply. Work closely with the developer of the publishing service to make sure that your reply document is an instance of the correct publishable document type.

For more information about building a reply service, see the Publish-Subscribe Developer’s Guide.

See Also

pub.publish:deliverAndWaitpub.publish:publishAndWaitpub.publish:envelope

pub.publ ish:waitForReplyWmPublic. Retrieves the reply for an asynchronous request. If a reply is not available, the Integration Server continues to wait for the document until the time specified in the waitTime parameter of the pub.publish:deliverAndWait or pub.publish:publishAndWait service elapses.

Input Parameters

Output Parameters

tag String A unique identifier for the publish request for which you are retrieving a reply. The Integration Server uses the tag value to match the request document with its corresponding reply document.

receivedDocument Document Document (IData object) received as the reply to the request. If the request expires (that is, the waitTime elapses) before the Integration Server receives the reply document, the receivedDocument field contains a null document.



pub.publish.notification:error

Usage Notes

The waitTime value of the publishing service specifies how long the Integration Server will keep the request open while waiting for a reply. When building an asynchronous request/reply service, keep the following information about the waitTime in mind:

The waiting interval for the reply document starts when the Integration Server executes the request service (pub.publish:deliverAndWait or pub.publish:publishAndWait). The execution of the pub.publish:waitForReply service does not affect the waitTime interval.

If the waitTime interval elapses before the pub.publish:waitForReply service executes, the service immediately returns a null document which indicates that the wait time has expired.

If the Integration Server has not received the reply when the pub.publish:waitForReply service executes, the service waits the remainder of the waitTime interval. If the Integration Server does not receive a reply by the time the waitTime interval elapses, the request completes. The service returns a null document which indicates that the wait time has expired.

If the reply document arrives after the waitTime interval elapses, the Integration Server rejects the document because the request is closed.

A single publish and wait request might receive many response documents. The Integration Server that made the publish and wait request uses only the first reply document it receives from the Broker. The Integration Server discards all other replies. First is arbitrarily defined. There is no guarantee provided for the order in which the Broker processes incoming replies. If you need a reply document from a specific client, use the pub.publish:deliverAndWait service instead.

For more information about building an asynchronous request/reply service, see the Publish-Subscribe Developer’s Guide.

See Also

pub.publish:deliverAndWaitpub.publish:publishAndWait

pub.publ ish.not i f icat ion:errorWmPublic. Publishable document type that defines the document that is delivered when a trigger encounters an error or exception condition.

Such conditions include:

The service being executed encounters an exception condition.

The number of retries for the trigger is exceeded.

Some other system exception occurred.

Note: If one of these conditions is met as a response to a local publish, an error document will be delivered only if the Integration Server is connected to a Broker.



The document is delivered to the client ID specified in the errorsTo envelope parameter of the document that caused the trigger to fire. If the errorsTo field is empty, the document is delivered to the document’s publisher (as specified in the pubId envelope field). This mechanism allows a publisher (or other designated recipient) to be notified when a subscriber is unable to successfully process a document from the publisher.

Parameters

See Also


adapterType String Optional. The resource producing the error. The Integration Server sets the value of this field to Integration Server.

errorCategory String Optional. Type of exception. The Integration Server sets the value of this field to Application.

errorText String Optional. Exception text message. At Dispatcher debug level 9, a stack trace of the exception will also be returned.

eventID java.lang.Long Optional. The event ID of the document that caused this exception. If the satisfying of a join condition caused the trigger to execute, then it is the event ID of the last document that satisfied the condition.

_env Document Optional. A document reference to the pub.publish:envelope document type.


C H A P T E R19
Record Folder
You use the elements in the record folder to perform operations on documents (IData objects) in the pipeline.

Important! The services in this folder have been deprecated. To operate on documents (IData objects), use the services in the document folder.


C H A P T E R 1 9 R e c o r d F o l d e r


pub.record: lengthWmPublic. Deprecated—Use pub.list:sizeOfList.

Returns the number of documents in a document list.

Input Parameters

Output Parameters

pub.record:recordListToRecordWmPublic. Deprecated—Use pub.document:documentListToDocument.

Constructs a document (an IData object) from a document list (an array of IData objects) by generating key/value pairs from the values of two elements that you specify in the document list.

The following illustrates how pub.record:recordListToRecord would convert a document list that contains three documents to a single document containing three key/value pairs. When you use recordListToRecord, you specify which two elements from the source list are to be transformed into the keys and values in the output document. In this example, the values from the pName elements in the source list are transformed into key names, and the values from the pValue elements are transformed into the values for these keys.


pub.record:length WmPublic. Deprecated—Use pub.list:sizeOfList.

pub.record:recordListToRecord WmPublic. Deprecated—Use pub.document:documentListToDocument.

pub.record:recordToRecordList WmPublic. Deprecated—Use pub.document:documentToDocumentList.

pub.record:recordToXMLValues WmPublic. Deprecated—Use pub.document:documentToXMLValues.

pub.record:XMLValuesToRecord WmPublic. Deprecated—Use pub.document:XMLValuesToDocument.

recordList Document List Document list whose length you want to discover.

length String Number of documents in the input document list. This parameter is not present if the input document list is null.


pub.record:recordToRecordList

Input Parameters

Output Parameters

pub.record:recordToRecordListWmPublic. Deprecated—Use pub.document:documentToDocumentList.

Expand the contents of a document into a list of documents. Each name/value pair in the target document will become a new document in a document list with constant keys for name and value.

A document List containing these 3 documents... Would be converted to a document containing these 3 keys...

Key Value Key Value

pName cx_timeout cx_timeout 1000

pValue 1000

pName cx_max cx_max 2500

pValue 2500

pName cx_min cx_min 10

pValue 10

recordList Document List List of documents (IData[ ]) whose contents you want to transform into a single document (IData object).

Note: If recordList contains an IData instead of an IData[ ], pub.record:recordListToRecord does nothing.

name String Name of the element in recordList whose value will provide the name of each key in the resulting document.

Important! The data type of the element that you specify in name must be String.

value String Name of the element in recordList whose value will be assigned to the key specified in name. This element can be of any data type.

record Document Document (IData object) containing the key/value pairs generated from recordList.


C H A P T E R 1 9 R e c o r d F o l d e r

Input Parameters

Output Parameters

pub.record:recordToXMLValuesWmPublic. Deprecated—Use pub.document:documentToXMLValues.

Converts a document (IData object) in the pipeline to a String by encoding it as webMethods XMLValues format.

Input Parameters

Output Parameters

pub.record:XMLValuesToRecordWmPublic. Deprecated—Use pub.document:XMLValuesToDocument.

Converts an XML String in webMethods XMLValues format to a document.

Input Parameters

Output Parameters

record Document Target document to transform.

name String Name to use for the keys of the target document.

value String Name to use for the values of the target document.

recordList Document List Resulting document list. The length of the document list is equal to the number of fields in the input document. Each document contains two fields: name and value.

record Document Target document to convert. This document can contain any number of other fields, lists, and other documents.

xmlvalues String String representation of record, encoded in webMethods XMLValues format.

xmlvalues String Representation of a document in webMethods XML Values encoded form. No other format is accepted.

record Document List Document resulting from the decoding of xmlvalues.


C H A P T E R20
Remote Folder
You use the elements in the remote folder to invoke services on other webMethods Integration Servers.

You can also use remote services for guaranteed delivery transactions. For more information about guaranteed delivery transactions, see the Guaranteed Delivery Developer’s Guide and the webMethods Integration Server Administrator’s Guide.


C H A P T E R 2 0 R e m o t e F o l d e r


pub.remote: invokeWmPublic. Invokes a service on a remote webMethods Integration Server.

The remote server is identified by an alias, which is configured on the Remote Servers tab in the Integration Server Administrator. Connection and authentication to the remote server is managed transparently to the caller of this service.

All current pipeline inputs are passed to the remote service. To improve performance and minimize the amount of data sent over the wire, scope the pipeline to a separate document or drop unneeded fields before invoking this service. The same advice applies to the output values of the remote service because all values returned from the service are sent over the wire in response to the caller.


pub.remote:invoke WmPublic. Invokes a service on a remote webMethods Integration Server.

pub.remote.gd:end WmPublic. Ends a guaranteed delivery transaction.

pub.remote.gd:getStatus WmPublic. Returns the status of the guaranteed delivery transaction.

pub.remote.gd:invoke WmPublic. Invokes the service for a guaranteed delivery transaction by making a synchronous call to a remote webMethods Integration Server.

pub.remote.gd:restart WmPublic. Restarts an expired guaranteed delivery transaction.

pub.remote.gd:retrieve WmPublic. Retrieves the results of a guaranteed delivery transaction submitted asynchronously or synchronously to a remote webMethods Integration Server.

pub.remote.gd:send WmPublic. Makes a guaranteed one-way call (fire-and-forget) to the webMethods Integration Server to invoke a service for which no output is needed or expected.

pub.remote.gd:start WmPublic. Starts a guaranteed delivery transaction.

pub.remote.gd:submit WmPublic. Invokes a service for a guaranteed delivery transaction by making an asynchronous call to a remote webMethods Integration Server.


pub.remote:invoke

Input Parameters

Output Parameters

Returns the output of the invoked service. The output signature matches the output signature of the invoked service.

Usage Notes

If pub.remote:invoke does not receive a response within the timeout period specified in the server’s watt.net.timeout parameter, it will throw an exception. For information about the watt.net.timeout parameter, see the webMethods Integration Server Administrator’s Guide.

$alias String Name of the target server on which to invoke the specified service. This name and its associated connection attributes are defined on the Create Remote Server Alias screen in the Integration Server Administrator.

Note: If you protect the alias using an Access Control List, the user invoking invoke must be a member of this list or the invocation will fail.

$service String Fully qualified name of the service to invoke on the remote server, in the format folderName.folderName:serviceName (for example: wm.server:ping).

$scope String Flag that specifies how the session to the remote server should be managed.

Set to... To...

SESSION Default. Store the remote session in the current user session. Further calls by the same user to pub.remote:invoke for the same server alias reuse the existing remote session with the server.

Stateful interactions with the remote server are maintained and protected inside the current user’s session.

When the current user disconnects, the remote session expires, or the local server is shut down, the remote session is automatically disconnected.

GLOBAL Store the remote session in a shared pool of sessions. If another user invokes a service on the same remote server with GLOBAL scope, the session will be reused.

Stateful interactions with the remote server could be destroyed by other users’ invocations.

When the remote session expires due to inactivity or the local server is shut down, the remote session is automatically disconnected.



pub.remote.gd:endWmPublic. Ends a guaranteed delivery transaction.

Input Parameters

Output Parameters

None.

Usage Notes

This service is used to eliminate a guaranteed delivery transaction from the jobstore.

pub.remote.gd:getStatusWmPublic. Returns the status of the guaranteed delivery transaction.

Input Parameters

Output Parameters

Usage Notes

Use the pub.remote.gd:restart service to restart a FAILED (expired) guaranteed delivery transaction.

tid String Transaction ID of the transaction you want to end.

tid String Transaction identification number.

status String Current status of the transaction. status can have one of the following values:


NEW The transaction is new.

PENDING The transaction is pending.

DONE The transaction is completed.

FAILED The transaction expired because the time-to-live or the retry limit has been exceeded.

UNKNOWN The transaction identification number in tid is not recognized.


pub.remote.gd:invoke

pub.remote.gd: invokeWmPublic. Invokes the service for a guaranteed delivery transaction by making a synchronous call to a remote webMethods Integration Server.

Input Parameters

Output Parameters

Usage Notes

To use an asynchronous call to the server to invoke a service for a guaranteed delivery transaction, use the pub.remote.gd:submit service.

If the remote server does not respond within the timeout limit specified in this server’s watt.net.timeout setting, the Integration Server treats it as a failed attempt and retries the request.

pub.remote.gd:restartWmPublic. Restarts an expired guaranteed delivery transaction.

Input Parameters

Output Parameters

None.

Usage Notes

If a guaranteed delivery transaction failed because of server or network failure, use this service to restart the transaction without resubmitting it.

service String Name of the service to be run on the remote webMethods Integration Server.

tid String Transaction identification number for the service.

inputs Document Optional. Document (IData object) containing the inputs for the service.

results Document Conditional. Document (IData object) containing the pipeline as it exists after the service is invoked.

tid String Transaction identification number for the guaranteed delivery transaction you want to restart.



pub.remote.gd:retr ieveWmPublic. Retrieves the results of a guaranteed delivery transaction submitted asynchronously or synchronously to a remote webMethods Integration Server.

Input Parameters

Output Parameters

Usage Notes

If block is false, and the results of the transaction are still pending when this service executes, the results are returned as null.

pub.remote.gd:sendWmPublic. Makes a guaranteed one-way call (fire-and-forget) to the webMethods Integration Server to invoke a service for which no output is needed or expected.

Input Parameters

Output Parameters

None.


block String Optional. Flag that specifies whether to block or poll for the results of the transaction.

Set to... To...

true Default. Wait until the invoked service completes before retrieving results. This is also known as blocking mode.

false Retrieve the results immediately, whether or not the invoked service is completed. This is also known as polling mode.

results Document Conditional. Document (IData object) containing the results of the service in the guaranteed delivery transaction.

service String Service to be run on the remote Integration Server.




pub.remote.gd:start

Usage Notes

The results of the service specified in service cannot be retrieved. However, errors that occur will be logged when the guaranteed delivery transaction ends.

Use the pub.remote.gd:send service to invoke a service remotely only if you want to run a guaranteed delivery transaction and are not concerned about the results of the invoked service. After pub.remote.gd:send completes the call, the service ends the transaction; therefore, you do not need to use the pub.remote.gd:end service to end the transaction.

pub.remote.gd:startWmPublic. Starts a guaranteed delivery transaction.

Input Parameters

Output Parameters

pub.remote.gd:submitWmPublic. Invokes a service for a guaranteed delivery transaction by making an asynchronous call to a remote webMethods Integration Server.

Input Parameters

alias String Name of the webMethods Integration Server on which you want to invoke a guaranteed delivery transaction. This name and its associated connection attributes are defined on the Remote Servers tab of the Integration Server Administrator.

ttl String Optional. Transaction time-to-live measured in minutes. The transaction expires when ttl is exceeded.

Default is the value set in the watt.tx.defaultTTLMins property or, if the property is not set, 30 minutes.

retries String Optional. Maximum number of times to retry the transaction. Default is 0 (no retry limit).

followtid String Optional. Identification number of the transaction you want this guaranteed delivery transaction to follow. The current transaction executes only after the transaction indicated by followtid completes.


service String Service to be run on the remote webMethods Integration Server.





Output Parameters

None.

Usage Notes

To remove the transaction from the remote webMethods Integration Server, use the pub.remote.gd:end service.

To use a synchronous call to invoke the service, use the pub.remote.gd:invoke service.


C H A P T E R21
Replicator Folder
You use the elements in the replicator folder to replicate packages across webMethods Integration Servers. This folder contains services that you can use to push packages from your webMethods Integration Servers to a subscriber’s server. It also contains services that you can use to pull packages from a publisher’s server to your webMethods Integration Server.


C H A P T E R 2 1 R e p l i c a t o r F o l d e r


pub.repl icator:addReleaseRegistryEntryWmPublic. Adds an entry to the webMethods Integration Server’s Package Release Registry.

Input Parameters


pub.replicator:addReleaseRegistryEntry WmPublic. Adds an entry to the webMethods Integration Server’s Package Release Registry.

pub.replicator:deleteReleaseRegistryEntry WmPublic. Deletes an entry from the webMethods Integration Server’s Package Release Registry.

pub.replicator:distributeViaFTP WmPublic. Allows a publisher to send a package to a subscriber via FTP or allows a subscriber to retrieve a package from a publisher via FTP.

pub.replicator:distributeViaSvcPull WmPublic. Pulls a specified package release from a publisher’s server.

pub.replicator:distributeViaSvcPush WmPublic. Pushes a package from your server to a list of subscribers (other webMethods Integration Servers).

pub.replicator:generateReplicationEvent WmPublic. Generates a replication event.

pub.replicator:getLocalReleasedList WmPublic. Returns all entries in your webMethods Integration Server’s Package Release Registry.

pub.replicator:getRemoteReleasedList WmPublic. Queries the publisher for released packages.

pub.replicator:notifyPackageRelease WmPublic. Sends an email message to subscribers who have said that they want to be notified when a new release becomes available.

pub.replicator:packageCreation WmPublic. Creates a distribution file (a zip file) for the package.

package String Name of the package. The service confirms that this package exists on the server before adding an entry to the Package Release Registry.

name String Name of the release. This name could be different from the name of the package.

version String Version number of the release, in the format #.# or #.#.# (for example, 1.2 or 1.2.1).


pub.replicator:deleteReleaseRegistryEntry

Output Parameters

Usage Notes

Before using this service, use pub.replicator:packageCreation to create a package zip file in the server’s outbound directory. When you use addReleaseRegistryEntry to add an entry to the Package Release Registry, the package name you specify in package should match the package name you specified in pub.replicator:packageCreation.

pub.repl icator:deleteReleaseRegistryEntryWmPublic. Deletes an entry from the webMethods Integration Server’s Package Release Registry.

Input Parameters

build String Build number of the release (for example, 12, 530).

patchNums String One or more comma-separated patch numbers included in this release.

JVMVersion String Minimum JVM version number that this release requires.

description String Brief description of this release. You may want to use this parameter to summarize the nature and purpose of the release.

packages Document List Entries in the server’s Package Release Registry.

Key Description

name String Name of the release.


build String Conditional. Build number of the release (for example, 12, 530).

patch_nums String Conditional. Comma-separated list of patch numbers included in this release.

time String Time when the package was released.

jvm_version String Minimum JVM version number that the release requires.

description String Conditional. Brief description of this release.

source_server_version String Version number of Integration Server that released the package.

packageName String Name of the release that you want to delete.



Output Parameters

pub.repl icator:distr ibuteViaFTPWmPublic. Allows a publisher to send a package to a subscriber via FTP or allows a subscriber to retrieve a package from a publisher via FTP.

Input Parameters

packages Document List Entries that remain in the server’s Package Release Registry.

Key Description




patch_nums String Conditional. Comma-separated list of patch numbers included in this release.



description String Conditional. Brief description of the release.

source_server_version String Version number of Integration Server that released the package.

packageName String Name of the released package.

action String Flag that specifies whether you want to send (put) a package to another Integration Server or whether you want to retrieve (get) a package from another Integration Server.

Set to... To...

get Default. Retrieve a package from the publisher’s server.

put Send a package to a subscriber’s server.

serverhost String Host name or IP address of the remote Integration Server.

serverport String Number of the FTP port on the remote Integration Server.

username String User name that your server will use to log on to the remote Integration Server.


pub.replicator:distributeViaSvcPull

Output Parameters

None.

pub.repl icator:distr ibuteViaSvcPul lWmPublic. Pulls a specified package release from a publisher’s server.

Input Parameters

Output Parameters

None.

pub.repl icator:distr ibuteViaSvcPushWmPublic. Pushes a package from your server to a list of subscribers (other webMethods Integration Servers).

Input Parameters

Output Parameters

None.

pub.repl icator:generateRepl icat ionEventWmPublic. Generates a replication event.

You might invoke this service in conjunction with other services to make the package replication process generate an event. The replication event handler would listen for this event and perform some prescribed action that you have specified.

Input Parameters

password String Password that your server will use to log on to the remote Integration Server.

packageName String Name of the release.

publisher String Alias of the publisher’s server.

packageName String The name of the release.

subscriber String List List of the subscriber’s host names or IP addresses.

packageName String Name of the package.



Output Parameters

None.

pub.repl icator:getLocalReleasedListWmPublic. Returns all entries in your webMethods Integration Server’s Package Release Registry.

Input Parameters

None.

Output Parameters

pub.repl icator:getRemoteReleasedListWmPublic. Queries the publisher for released packages.

This service gets a list of released packages to which your server subscribes. You can use the list to find out if any new packages, or newer versions of existing packages, have been released.

action String User-defined string that describes the replication event, such as “pulled” or “pushed.”

packages Document List Entries in the server’s Package Release Registry.

Key Description




patch_nums String Conditional. Comma-separated list of the patch numbers included in this release.




source_server_version String Version number of webMethods Integration Server that released the package.


pub.replicator:notifyPackageRelease

Input Parameters

Output Parameters

pub.repl icator:not i fyPackageReleaseWmPublic. Sends an email message to subscribers who have said that they want to be notified when a new release becomes available.

Input Parameters

Output Parameters

None.

publisher String Alias of the publishing server.

packages Document List List of released packages on the publishing server to which you subscribe.

Key Description




patch_nums String Conditional. Comma-separated list of the patch numbers included in this release.




source_server_version String Version number of webMethods Integration Server that released the package.

packageName String Name of the release.



pub.repl icator:packageCreat ionWmPublic. Creates a distribution file (a zip file) for the package.

Input Parameters

package String Name of the package.



build String Build number of the release (for example, 12, 530).

patchNums String Comma-separated list of patch numbers included in the release.

targetPkgVersion String Version number of the target package. To prevent the installation program from overwriting an existing (higher) version of the package, this field is checked when the subscriber installs this package over an existing package.

targetServerVersion String Version number of the webMethods Integration Server that this release requires.

JVMVersion String Minimum JVM version number that this release requires.

description String Brief description of this release. You might use this parameter to summarize the nature and purpose of the release.

type String Flag indicating the type of release.

Set to... To...

full Default. Indicate a full package.

partial Indicate a patch or an update for the package.

filter String Flag that specifies whether all files are to be included in the distribution file or only selected files.

If only selected files are to be included, use this parameter in conjunction with fileList to specify which files to include.

Set to... To...

includeall Default. Include all the files in the distribution file.

include Include selected files in the distribution file.

exclude Include all except selected files in the distribution file.

fileList String List Names of files to include or exclude from the distribution file, depending on the value of filter.


pub.replicator:packageCreation

Output Parameters

Usage Notes

After you use packageCreation to create the package, use pub.replicator:addReleaseRegistryEntry to add an entry to the Package Release Registry. The package name you specify in packageCreation should match the package name you specify in pub.replicator:addReleaseRegistryEntry.

fileNamePattern String Pattern string that specifies the names of files to be included in the distribution file. The asterisk (*) is the only wildcard character allowed in a pattern string. All other characters are treated literally (for example, *.java, *.dsp).

filesToDeleteList String List Optional. The names of files that will be deleted from the target package when the subscribing server installs the package created by this service.

$result String Conditional. If the distribution file is created successfully, this parameter contains the value OK. If the distribution file was not created successfully, this parameter is not present in the output signature and the service throws an exception.


C H A P T E R22
Report Folder
You use the elements in the report folder to apply an output template to a Values object. Each service requires an output template and a Values object. They can be used in order to generate any type of dynamic XML, EDI, or HTML document.


C H A P T E R 2 2 R e p o r t F o l d e r


pub.report:runFi leTemplateWmPublic. Applies a template file to a document (IData object).

Input Parameters

Output Parameters

Usage Notes

If a template is not available in a templates directory of any of the packages on the server, you can use this service by passing in a File object representing the template.


pub.report:runFileTemplate WmPublic. Applies a template file to a document (IData object).

pub.report:runFileTemplateOnPipe WmPublic. Applies a template to the pipeline.

pub.report:runStringTemplate WmPublic. Applies an output template to a specified document (IData object).

pub.report:runStringTemplateOnPipe WmPublic. Applies a template to the pipeline.

pub.report:runTemplate WmPublic. Applies a template in a file to a specified document (IData object).

pub.report:runTemplateOnPipe WmPublic. Applies a template in a file to the pipeline.

$template java.io.File Template file.

$values Document Document (IData object) to bind against $template.

fileEncoding String Optional. The encoding of the template file. If fileEncoding is not specified, the default file encoding specified in the watt.server.netEncoding server parameter or the system file encoding will be used. Examples: SJIS, ASCII, ISO8859_1.

$txt String Results from applying $template to $values.


pub.report:runFileTemplateOnPipe

pub.report:runFi leTemplateOnPipeWmPublic. Applies a template to the pipeline.

Input Parameters

Output Parameters

Usage Notes

If a template is not available in a templates directory of any of the packages on the server, you can use this service to pass a File object representing the template file.

pub.report:runStringTemplateWmPublic. Applies an output template to a specified document (IData object).

Input Parameters

Output Parameters

Usage Notes

This service is typically invoked from other services that already have a template in a String object and an IData object that will be used to bind against the template.

$template java.io.File Template file.


$txt String Results from applying $template to the pipeline.

$template String Template to apply.


$txt String Results from applying $template to $values.



pub.report:runStr ingTemplateOnPipeWmPublic. Applies a template to the pipeline.

Input Parameters

Output Parameters

Usage Notes

This service is typically invoked from other services that already have a template in a String object and need the template to bind against the pipeline.

pub.report:runTemplateWmPublic. Applies a template in a file to a specified document (IData object).

Input Parameters

Output Parameters

Usage Notes

The service locates the output template by its file name and the name of the package in which it resides. To apply a template that resides in webMethods6\IntegrationServer\packages\Default\templates\mytemp.xml, invoke the service with the following values.

$template: mytemp.xml

$package: Default

$template String Template to apply to pipeline.

$txt String Result from applying $template to the pipeline.

$template String Name of the template file (for example, mytemp.html or mytemp.xml).

$package String Name of the package where the template resides (for example, Default).



$txt String Result from applying the template to $values.


pub.report:runTemplateOnPipe

pub.report:runTemplateOnPipeWmPublic. Applies a template in a file to the pipeline.

Input Parameters

Output Parameters

Usage Notes

The service locates the output template by its file name and the name of the package in which it resides. To apply a template that resides in webMethods6\IntegrationServer\packages\Default\templates\mytemp.xml, Invokes the service with the following values.

$template: mytemp.xml

$package: Default

$template String Name of template file (for example, mytemp.html or mytemp.xml).

$package String Name of the package in which the template resides (for example, Default).


$txt String Results from applying the template file to the pipeline.


C H A P T E R23
Scheduler Folder
You use the elements in the scheduler folder to execute services at the times you specify. Services that you schedule are referred to as user tasks or just tasks. The Scheduler feature on the webMethods Integration Server handles execution of the tasks.


C H A P T E R 2 3 S c h e d u l e r F o l d e r


pub.scheduler:addComplexTaskWmPublic. Adds a complex task to the Scheduler.

The webMethods Integration Server runs the service for a complex task on the day(s) and time(s) that you specify either during a specified date range or indefinitely.

Input Parameters


pub.scheduler:addComplexTask WmPublic. Adds a complex task to the Scheduler.

pub.scheduler:addOneTimeTask WmPublic. Adds a task that runs only once to the Scheduler.

pub.scheduler:addRepeatingTask WmPublic. Adds a recurring task to the Scheduler.

pub.scheduler:cancelTask WmPublic. Removes a task from the Scheduler.

pub.scheduler:getTaskIDs WmPublic. Retrieves a list of identification numbers for of all tasks currently in the Scheduler.

pub.scheduler:getTaskInfo WmPublic. Retrieves information about a task on the Scheduler.

pub.scheduler:resumeTask WmPublic. Resumes a suspended task.

pub.scheduler:suspendTask WmPublic. Suspends a task on the Scheduler.

pub.scheduler:updateComplexTask WmPublic. Updates a complex task on the Scheduler.

pub.scheduler:updateOneTimeTask WmPublic. Updates a one-time task on the Scheduler.

pub.scheduler:updateRepeatingTask WmPublic. Updates a repeating task to the Scheduler.

service String Name of the service you want to schedule for execution on the server.

runAsUser String Optional. User ID under which the service is to be executed. If you do not specify a user name, the “Default” access rights are used.

persistJob String Optional. Flag that indicates whether you want the task to persist after the server is restarted.

Set to... To...

true Persist the task after the server is restarted.

false Default. Do not persist the task after the server is restarted.


pub.scheduler:addComplexTask

Output Parameters

runInCluster String Optional. Flag that indicates whether you want the task to run in a clustered environment.

Set to... To...

true Run the task in a clustered environment.

false Default. Run the task in a non-clustered environment.

inputs Document Optional. Document (IData object) containing the input to the scheduled service.

startTime String Optional. Time at which the task is scheduled to start, in the format HH:mm:ss. If you do not specify a startTime, the current time is used.

startDate String Optional. Date on which the task is scheduled to start, in the format yyyy/MM/dd. If you do not specify a startDate, the current date is used.

endTime String Optional. Time at which the task expires, in the format HH:mm:ss. If you do not specify an endTime, the server uses 00:00:00 (midnight).

endDate String Optional. Date on which the task expires, in the format yyyy/MM/dd. If you do not specify an endDate, the server executes this service for an indefinite period of time.

months String List Optional. Months during which the task is scheduled to run. Months are represented by integers between 1 and 12, where “1” indicates January and “12” indicates December. If you do not specify months, the task will run every month.

hours String List Optional. Hours at which the task is scheduled to run. Hours are represented by integers between 0 and 23. If you do not specify hours, the task runs every hour.

minutes String List Optional. Minutes at which the task is scheduled to run. Minutes are represented by integers between 0 and 59. If you do not specify minutes, the task runs every minute.

daysOfMonth String List Optional. Days of the month on which the task is scheduled to run. Days are represented by integers between 1 and 31. If you do not specify daysOfMonth, the task runs every day of the month.

daysOfWeek String List Optional. Days of the week on which the task is scheduled to run. Days are represented by integers between 1 and 7, where “1” indicates Sunday and “7” indicates Saturday. If you do not specify daysOfWeek, the task runs every day of the week.

taskID String Identification number of the task added to the scheduler.

type String Code indicating the type of task added. For this type of task, the value of type will be complex.



pub.scheduler:addOneTimeTaskWmPublic. Adds a task that runs only once to the Scheduler.

The Integration Server executes the service a single time on the date and time you specify.

Input Parameters

Output Parameters

taskAdded String Indicates whether the task was successfully added to the Scheduler. If the task was successfully added to the Scheduler, taskAdded contains true. If the task was not successfully added, the server throws an exception and terminates the service.

service String Name of the service you want to schedule for execution.


persistJob String Optional. Flag that indicates whether you want the server to maintain the scheduled task in the event that the server is restarted before the task completely executes.

Set to... To...




Set to... To...



inputs Document Optional. Document (IData object) containing input to the scheduled service.

date String Date on which to run the service, in the format yyyy/MM/dd.

time String Time at which to run the service, in the format HH:mm:ss.

taskID String Identification number of the task added to the scheduler.

type String Code indicating the type of task added. For this type of task, the value of type will be once.


pub.scheduler:addRepeatingTask

pub.scheduler:addRepeat ingTaskWmPublic. Adds a recurring task to the Scheduler.

The webMethods Integration Server continually executes a repeating task at the interval you specify.

Input Parameters


service String Name of the service you want to schedule for execution on the server.


persistJob String Optional. Flag that indicates whether you want the task to persist after the server is restarted.

Set to... To...




Set to... To...




interval String Time interval (measured in seconds) between executions of the task.

doNotOverlap String Optional. Flag that indicates whether you want executions of this task to overlap.

Set to... To...

true Prevent executions of the scheduled task from overlapping. After a scheduled task finishes executing, the Scheduler waits the number of seconds specified in interval before running the task again.

false Default. Allow executions of the scheduled task to overlap. The Scheduler runs the task every time the value of interval elapses.



Output Parameters

pub.scheduler:cancelTaskWmPublic. Removes a task from the Scheduler.

Input Parameters

Output Parameters

Usage Notes

For information about the tasks on the Scheduler, run the pub.scheduler:getTaskIDs and pub.scheduler:getTaskInfo services.

pub.scheduler:getTaskIDsWmPublic. Retrieves a list of identification numbers for of all tasks currently in the Scheduler.

Input Parameters

None.

Output Parameters

taskID String Identification number of the task added to the Scheduler.

type String Code indicating the type of task added. For this type of task, the value of type will be repeat.


taskID String Identification number of the task to remove from the Scheduler.

taskCancelled String Indicates whether the task was successfully removed from the Scheduler. If the task was successfully removed from the Scheduler, taskCancelled contains true. If the task was not successfully removed, the server throws an exception and terminates the service.

taskIDs String List Identification numbers for the tasks on the Scheduler.


pub.scheduler:getTaskInfo

pub.scheduler:getTaskInfoWmPublic. Retrieves information about a task on the Scheduler.

Input Parameters

Output Parameters

taskID String Task identification number.

type String Code indicating the task’s type. Will be one of the following:complexoncerepeat

runAsUser String The user ID whose access rights are used to execute the service.

service String Name of the service associated with the task.

runInCluster String Flag indicating whether or not the task is permitted to run in a clustered environment.


true The task runs in a clustered environment.

false The task does not run in a clustered environment.

persistJob String Flag indicating whether the task persists if the server on which the task is running is restarted.


true The task persists if server is restarted.

false The task does not persist if server is restarted.

nextRun String Next date and time that the task is scheduled to run. The date and time is expressed as the number of milliseconds from January 1, 1970, 00:00:00 GMT.

execState String Current state of the task. Tasks can be in one of two states:


running The task is currently active.

suspended The task has been suspended.

inputs Document Conditional. Document (IData object) containing the inputs, if any, to the scheduled service.

oneTimeTaskInfo Document Conditional. Information about the complex task represented by taskID. This parameter is present only if type is once.



Key Description

date String Conditional. Date on which to run the task, in yyyy/MM/dd format.

time String Conditional. Time at which to run the task, in HH:mm:ss format.

repeatingTaskInfo Document Conditional. Information about the task represented by taskID. This parameter is present only if type is repeat.

Key Description

interval String Conditional. Time interval (measured in seconds) between repetitions of the task.

doNotOverlap String Conditional. Indicates whether recurrences of this task will overlap.

complexTaskInfo Document Conditional. Information about the task. This parameter is present only if type is complex.

Key Description

startDate String Conditional. Date on which the task is scheduled to start, in yyyy/MM/dd format.

startTime String Conditional. Time at which the task is scheduled to start, in HH:mm:ss format.

endDate String Conditional. Date on which the task expires, in yyyy/MM/dd format.

endTime String Conditional. Time at which the task expires, in HH:mm:ss format.

minutes String List Conditional. Minutes at which the task is scheduled to run. Minutes are represented by integers between 0 and 59.

hours String List Conditional. Hours when the task is scheduled to run. Hours are represented by integers between 0 and 23.

months String List Conditional. Months during which the task is scheduled to run. Months are represented by integers between 1 and 12, where “1” indicates January and “12” indicates December.

daysOfWeek String List Conditional. Days of the week on which the task is scheduled to run. Days are represented by integers between 1 and 7, where “1” indicates Sunday and “7” indicates Saturday.

daysOfMonth String List Conditional. Days of the month on which the task is scheduled to run. Days are represented by integers between 1 and 31.


pub.scheduler:resumeTask

pub.scheduler:resumeTaskWmPublic. Resumes a suspended task.

Input Parameters

Output Parameters

pub.scheduler:suspendTaskWmPublic. Suspends a task on the Scheduler.

Input Parameters

Output Parameters

Usage Notes

If you want to cancel a task or remove a task from the scheduler, use the pub.scheduler:cancelTask service.

pub.scheduler:updateComplexTaskWmPublic. Updates a complex task on the Scheduler.

The Integration Server runs the service for a complex task on the day(s) and time(s) that you specify either during a specified date range or indefinitely.

Input Parameters

taskID String Identification number of the task to resume.

taskResumed String Indicates whether the task was successfully resumed. If the task was successfully resumed, taskResumed contains true. If the task was not successfully resumed, the server throws an exception and terminates the service.

taskID String Identification number of the task to suspend.

taskSuspended String Indicates whether the task was successfully suspended. If the task was successfully suspended, taskSuspended contains true. If the task was not successfully suspended, the server throws an exception and terminates the service.

taskID String Identification number of the task to be updated.

service String Optional. Name of the service you want to schedule for execution on the server.




persistJob String Optional. Flag indicating whether you want the task to persist after the server is restarted.

Set to... To...



runInCluster String Optional. Flag indicating whether you want the task to run in a clustered environment.

Set to... To...




startTime String Optional. Time at which the task is scheduled to start, in HH:mm:ss format. If you do not specify a startTime, the current time is used.

startDate String Optional. Date on which the task is scheduled to start, in yyyy/MM/dd format. If you do not specify date, the current date is used.

endTime String Optional. Time at which the task expires, in HH:mm:ss format. If you do not specify an endTime, the server uses 00:00:00 (midnight).

endDate String Optional. Date on which the task expires, in yyyy/MM/dd format. If you do not specify an endDate, the server executes this service for an indefinite period of time.

months String List Optional. Months during which the task is scheduled to run. Months are represented by integers between 1 and 12, where “1” indicates January and “12” indicates December. If you do not specify months, the task will run every month.

hours String List Optional. Hours at which the task is scheduled to run. Hours are represented by integers between 0 and 23. If you do not specify hours, the task runs every hour.

minutes String List Optional. Minutes at which the task is scheduled to run. Minutes are represented by integers between 0 and 59. If you do not specify minutes, the task runs every minute.

daysOfMonth String List Optional. Days of the month on which the task is scheduled to run. Days are represented by integers between 1 and 31. If you do not specify daysOfMonth, the task runs every day of the month.


pub.scheduler:updateOneTimeTask

Output Parameters

Usage Notes

You can use pub.scheduler:getTaskIDs and pub.scheduler:getTaskInfo services to get information about the task you want to update.

Unlike the services pub.scheduler:updateOneTimeTask and pub.scheduler:updateRepeatingTask, this service updates all the fields in the task by default (that is, except values for taskID and type, all the parameter values you specified when you created or last updated the task are overwritten). Using this service to update a task is similar to creating a new complex task with the original taskID and type.

pub.scheduler:updateOneTimeTaskWmPublic. Updates a one-time task on the Scheduler.

Input Parameters

daysOfWeek String List Optional. Days of the week on which the task is scheduled to run. Days are represented by integers between 1 and 7, where “1” indicates Sunday and “7” indicates Saturday. If you do not specify daysOfWeek, the task runs every day of the week.

type String Code indicating the type of task that was updated. For this type of task, the value of type will be complex.

taskUpdated String Indicates whether the task was successfully updated. If the task was successfully updated, taskUpdated contains true. If the task was not successfully updated, the server throws an exception and terminates the service.


service String Optional. Name of the service to be scheduled.

runAsUser String Optional. User ID under which the service is to be executed.


Set to... To...






Output Parameters

Usage Notes

Unlike pub.scheduler:updateComplexTask, this service does not overwrite all the original parameter values. This service only updates the parameters for which you specify new values.

pub.scheduler:updateRepeat ingTaskWmPublic. Updates a repeating task to the Scheduler.

Input Parameters

Set to... To...



inputs Document Optional. Document (IData object) containing inputs to the scheduled service.

date String Optional. Date on which to run the task, in yyyy/MM/dd format.

time String Optional. Time at which to run the service, in HH:mm:ss format.

type String Code indicating the type of task that was updated. For this type of task, the value of type will be once.



service String Optional. Name of the service run by the task.



Set to... To...





pub.scheduler:updateRepeatingTask

Output Parameters

Usage Notes

Unlike pub.scheduler:updateComplexTask, this service does not overwrite all the original parameter values. This service only updates the parameters for which you specify new values.

Set to... To...



inputs Document Optional. Document (IData object) containing inputs to the scheduled service.

interval String Optional. Time interval (measured in seconds) between repetitions of the task.

doNotOverlap String Optional. Flag indicating whether or not you want the executions of this task to overlap.

Set to... To...

true Prevent executions of the scheduled task from overlapping. After a scheduled task finishes executing, the Scheduler waits the number of seconds specified in interval before running the task again.

false Default. Allow executions of the scheduled task to overlap. The Scheduler runs the task every time the value of interval elapses.

type String Code indicating the type of task updated. For this type of task, the value of type will be repeat.



C H A P T E R24
Schema Folder
You use the elements in the schema folder to validate objects and to validate the pipeline.


C H A P T E R 2 4 S c h e m a F o l d e r


pub.schema:createXSDWmPublic. Creates an XML Schema definition from a document type, from the input and output parameters of a service, or from a specification.

Input Parameters

Output Parameters


pub.schema:createXSD WmPublic. Creates an XML Schema definition from a document type, from the input and output parameters of a service, or from a specification.

pub.schema:validate WmPublic. Validates an object using an IS document type or a schema.

pub.schema:validatePipeline WmPublic. Validates the pipeline against a document type.

pub.schema.w3c WmPublic. This folder contains definitions for XML Schemas as defined in the W3C specification XML Schema Part 2: Datatypes.

pub.schema.w3c:xml WmPublic. A schema containing the XML Namespace components, such as xml:lang and xml:space, as defined in the W3C specifications Namespaces in XML and Extensible Markup Language (XML) 1.0.

pub.schema.w3c:xsi WmPublic. A schema containing the XML Schema instance components, such as xsi:nil, xsi:noNamespaceSchemaLocation, xsi:schemaLocation, and xsi:type, as defined in the W3C XML Schema recommendation Part 1: Structures.

name String Fully qualified name of a document type, service, or specification on the Integration Server.

isSuccessful String Flag indicating whether the schema definition was created successfully.


true The schema definition was created successfully.

false The schema definition was not created successfully. See errors for detailed information.

xsd Document Conditional. The schema definition xsd has the following keys:


pub.schema:createXSD

Usage Notes

If the document type, service signature, or specification you are providing as input to createXSD contains fields that belong to multiple XML namespaces, createXSD generates multiple XML Schema definitions (one for each XML namespace) and imports them into the XML Schema contained in the source field. These imported XML Schema definitions appear as children of xsd in the pipeline.

When using createXSD to create an XML Schema definition, keep the following points in mind:

Top-level strings are not allowed.

String tables beneath the top level are not allowed.

Field names must conform to QName lexical rules (that is, the prefix and local name must conform to NCName rules specified in http://www.w3.org/TR/REC-xml-names/#NT-NCName).

Field names cannot contain a prefix without an associated XML namespace.

Fields of type other than scalar string cannot have names that begin with the character @ or be named *body.

Fields at the same level (that is, beneath the same parent field in the input or output of the same signature) can have the same name but different types or properties. However, only one field's type and properties is used for all fields with that name at that level. Because the method used to select the field is not defined, webMethods recommends avoiding this case.

Only one field named *body can occur at the same level.

Key Description

url String Conditional. Relative url of the generated schema.

source String Conditional. Schema definition.

errors Document List List of fatal errors, if any, that occurred when generating the XSD. Each document in the list has the following structure:

Key Description

errorMessage String Text of the error message.

When fatal errors occur, the service does not generate an XSD file.

warnings Document List Conditional. List of non-fatal errors, if any, that were encountered while generating the XSD. Each document in the list has the following structure:

Key Description

warningMessage String Text of the warning message.

When non-fatal errors occur, the service generates the XSD file but also returns warnings to indicate that it encountered unusual or unexpected conditions during the process.


http://www.w3.org/TR/REC-xml-names/#NT-NCName





Duplicate field names that begin with the character @ cannot repeat at the same level.

Fields at different levels can have the same name with duplicate XML Namespace values, even if the fields have different types or properties. However, only one field's type and properties are used for all fields with that name at that level. Because the method used to select the field is not defined, webMethods recommends avoiding this case.

Object constraints are allowed. However, the Integration Server does not represent them in the XSD.

Strings constrained by older schema types (types defined before the W3C XML 2001 Schema recommendations) are allowed. However, the Integration Server translates them into 2001 XML Schema types.

If you use createXSD to create multiple XML Schema definitions that refer to each other, place the XSD files in the same folder or base path. To ensure that the references resolve correctly, make sure the relative URLs specified in the XSD files reflect the names of the XSD files within this folder or base path.

pub.schema:val idateWmPublic. Validates an object using an IS document type or a schema.

Input Parameters

object Document or com.wm.lang.xml.Document or com.wm.lang.xml.Node Object to be validated.

conformsTo String Document type or schema to validate object against.

If object is a document (IData object), conformsTo must specify the fully qualified name of a document type on the Integration Server.

If object is a com.wm.lang.xml.Document or com.wm.lang.xml.Node object, conformsTo must specify the fully qualified name of a schema on the Integration Server.

Note: The specified schema is used only for validating nodes with “Names” that are not from XML Namespaces (that is, qualified nodes whose XML Namespace Name properties are absent).

maxErrors String Optional. Number of errors to be collected. Default value is 1. When the number of errors found is equal to maxErrors, the validation processor stops validation and returns the result. If maxErrors is set to -1, the validation processor returns all errors.

ignoreContent String Optional. Flag that specifies whether the validation processor will validate content keys of the type String, String List, or String Table.


pub.schema:validatePipeline

Output Parameters

pub.schema:val idatePipel ineWmPublic. Validates the pipeline against a document type.

Input Parameters

Set to... To...

true Ignore content (that is, do not validate keys of these types).

false Default. Validate content.

failIfInvalid String Optional. Flag that indicates whether the service should fail and throw an exception if the object is invalid.

Set to... To...

true Indicate that the service should fail if the object is invalid.

false Default. Indicate that service should signal success and return errors to the pipeline if object is invalid.

isValid String Flag that indicates whether or not the validation was successful.


true The validation was successful.

false The validation was unsuccessful.

errors Document List Errors encountered during validation. Each document will contain the following information:

Key Description

pathName String Location of the error in XQL.

errorCode String Error code (for example, VV-001).

errorMessage String Error message (for example, Missing Object).

conformsTo String Fully qualified name of the document type that you want to validate against.

maxErrors String Optional. Number of errors to be collected. Default value is 1. When the number of errors found is equal to maxErrors, the validation processor stops validation and returns the result. If maxErrors is set to -1, the validation processor returns all errors.



Output Parameters

pub.schema.w3cWmPublic. This folder contains definitions for XML Schemas as defined in the W3C specification XML Schema Part 2: Datatypes.

For more information about schemas and datatypes, see the webMethods Developer User’s Guide and the webMethods Integration Server Schema Reference.

ignoreContent String Optional. Flag that specifies whether the validation processor will validate content keys of the type String, String List, or String Table.

Set to... To...

true Ignore content (that is, do not validate keys of these types).

false Default. Validate content.

failIfInvalid String Optional. Flag that indicates whether the service should fail and throw an exception if the object is invalid.

Set to... To...

true Indicate that service should fail if object is invalid.

false Default. Indicate that service should simply signal success and return errors to the pipeline if object is invalid.

isValid String Flag that indicates whether or not the validation was successful.


true The validation was successful.

false The validation was unsuccessful.

errors Document List Errors encountered during validation. Each document will contain the following information:

Key Description

pathName String Location of the error in XQL.

errorCode String Error code (for example, VV-001).

errorMessage String Error message (for example, Missing Object).


pub.schema.w3c:xml

pub.schema.w3c:xmlWmPublic. A schema containing the XML Namespace components, such as xml:lang and xml:space, as defined in the W3C specifications Namespaces in XML and Extensible Markup Language (XML) 1.0.

pub.schema.w3c:xsiWmPublic. A schema containing the XML Schema instance components, such as xsi:nil, xsi:noNamespaceSchemaLocation, xsi:schemaLocation, and xsi:type, as defined in the W3C XML Schema recommendation Part 1: Structures.


C H A P T E R25
Securi ty Folder
You use the elements in the security folder to control which client certificates are sent to other services and to digitally sign data and process digital signatures.

The pub.security:setKeyAndChain and pub.security:clearKeyAndChain services are used to control which client certificate the webMethods Integration Server presents to remote servers. You need to use these services to switch between certificates and certificate chains if you are not using aliases for remote servers. For more information about aliases for remote servers, see the webMethods Integration Server Administrator’s Guide.


C H A P T E R 2 5 S e c u r i t y F o l d e r



pub.security:clearKeyAndChain WmPublic. Associates the default key and certificate chain with the subsequent set of invoked services.

pub.security:setKeyAndChain WmPublic. Associates a key and certificate chain with the subsequent set of invoked services.

pub.security:getNumConnections WmPublic. Gets number of connections to a proxy server. (For use on an internal server only.)

pub.security.pkcs7:sign WmPublic. Creates a PKCS7 SignedData object.

pub.security.pkcs7:verify WmPublic. Processes a digital signature to make sure that the provided data has not been modified.

pub.security.reverseInvoke:deleteAllConnections WmPublic. Deletes all registration connections to a proxy server from an internal server.

pub.security.reverseInvoke:deleteConnection WmPublic. Deletes registered connections to a proxy server from an internal server.

pub.security.reverseInvoke:disableListeners WmPublic. Disables specified listener on a proxy or relay server.

pub.security.reverseInvoke:getNumConnections WmPublic. Gets number of connections to a proxy server. (For use on an internal server only.)

pub.security.reverseInvoke:getServerType WmPublic. Reports the type that this server is running as.

pub.security.reverseInvoke:keepAliveConnections WmPublic. Creates the maximum number of configured connections to the proxy server.

pub.security.reverseInvoke:listProxyListeners WmPublic. Lists the details about the proxy ports through which external clients make requests to the internal server. (For use on the reverse invoke server.)

pub.security.reverseInvoke:listRegisteredConnections WmPublic. Lists the connections to a proxy (when executed on an internal server) or lists the connections to an internal server (when executed on a proxy server).

pub.security.reverseInvoke:listRegistrationListeners WmPublic. Lists the details about registration listeners that accept connections from internal servers (for use on the reverse invoke server).


pub.security:clearKeyAndChain

pub.securi ty:clearKeyAndChainWmPublic. Associates the default key and certificate chain with the subsequent set of invoked services.

Input Parameters

None.

Output Parameters

None.

Usage Notes

The following scenario describes a situation in which you would use the pub.security:setKeyAndChain and pub.security:clearKeyAndChain services.

Company A has a webMethods Integration Server with one certificate chain. Company A wants to start trading with two new companies: Company B and Company C. Due to explicit business decisions, both Company B and Company C require that secure requests to their servers use certificates issued by their company’s certificate authority. Company A now has three certificate sets that it must manage: one for connections to B, one for connections to C, and one for all other requests. Below is a high-level process flow of what Company A would do if documents needed to be forwarded to companies B, C, and D (some arbitrary partner without the stringent security).

Assume all network communication is done using HTTPS. Documents are sent to the companies in the following order: Company D, Company B, Company C, Company D. All data transfers make use of the pub.client:http service.

1 Invoke pub.client:http to send data to Company D.

2 Invoke pub.security:setKeyAndChain using the key and certificate chain for Company B.

3 Invoke pub.client:http to send data to Company B.

4 Invokepub.security:setKeyAndChain using the key and certificate chain for Company C.

pub.security.reverseInvoke:registerReverseConnections WmPublic. Registers connections to the proxy server.

pub.security.util:createMessageDigest WmPublic. Generates a message digest for a given message.

pub.security.util:getCertificateInfo WmPublic. Retrieves information such as serial number, issuer, and expiration date from a digital certificate.

pub.security.util:loadPKCS7CertChain WmPublic. Converts a certificate chain that is in PKCS #7 format to a list of byte arrays.




5 Invoke pub.client:http to send data to Company C.

6 Invoke pub.security:clearKeyAndChain to revert back to the default key and certificate chain for Company A’s server.

7 Invoke pub.client:http to send data to Company D.

pub.securi ty:setKeyAndChainWmPublic. Associates a key and certificate chain with the subsequent set of invoked services.

Input Parameters

Output Parameters

None.

Usage Notes

Use this service to associate a key and certificate chain that is different from the default settings. See the Usage Notes for pub.security:clearKeyAndChain for more information about using this service.

pub.securi ty:getNumConnect ionsWmPublic. Gets number of connections to a proxy server. (For use on an internal server only.)

Input Parameters

Output Parameters

privKeyFile String Absolute (for example, D:\certs\cert1.der) or relative path of the file containing the private key. A relative path is the path relative to the directory from which the Integration Server has been started (for example, webMethods6\IntegrationServer\config\certs\cert1.der).

certFiles String List List of file names containing the certificates that comprise the certificate chain. The list should start with the user’s certificate followed by (in order) intermediate certificates and the root CA certificate.

Absolute or relative paths of the files can be specified.

alias String Alias of the proxy server for which you want to get the number of connections.

numConnections String Number of current connections to proxy server specified in alias.


pub.security.pkcs7:sign

pub.securi ty.pkcs7:signWmPublic. Creates a PKCS7 SignedData object.

This service enables multiple entities to sign the specified data. Each signerInfo block contained in the resulting signature contains two authenticated attributes: the content type and a timestamp.

Input Parameters

Output Parameters

signerInfo Document List Information about a single signer of the signed data object. Each signerInfo requires either a certificate chain and a private key or a key alias that references them.

Key Description

certChain java.security.cert.X509Certificate[ ] or byte[ ][ ] Certificate chain of the signer. The subject that is performing the signature should be the first certificate in this chain, while the root Certifying Authority should be the last. The key provided should correspond to the public key contained in the first certificate of the chain.

key java.security.PrivateKey or byte[ ] Private key that will be used to digitally sign the data. The private key can be any asymmetric encryption key that is supported by the webMethods Integration Server (for example, DSA or RSA).

keyAlias String Alias of the certificate chain and private key in the key store. This key is not currently used.

hashAlgorithm String The algorithm to use when computing the digest of the provided data (SHA-1 or MD5). The default value is MD5.

data byte[ ] Data to be digitally signed.

detachedSignature String Flag specifying whether to generate a detached signature. A detached signature does not include the data that was signed.

Set to... To...

true Generate a detached signature.

false Default. Generate an implicit signature (one that includes the signed data).

signature byte[ ] Signature generated from the supplied data. This is a DER-encoded representation of the SignedData object as specified in PKCS#7.



pub.securi ty.pkcs7:ver i fyWmPublic. Processes a digital signature to make sure that the provided data has not been modified.

Input Parameters

Output Parameters

signature byte[ ] Signature to use to determine whether the signed data is intact (a DER-encoded representation of the SignedData object as specified in PKCS#7). If you are processing a detached signature, pass the signature in signature. If you are processing an implicit signature, pass the entire signed message in signature.

data byte[ ] Optional. The data that was signed. If you are processing a detached signature, you must supply data. If you are processing an implicitly signed message, you do not need to supply data because both the message and the signature reside in signature.

detachedSignature String Optional. Flag indicating whether the message has a detached signature.

Set to... When...

true The message has a detached signature.

false Default. The message has an implicit signature.

signerCertChain byte[ ][ ] Optional. Certificate chains of the parties that signed the message.

Note: If the signers included the certificate chain with the digital signature, you do not need to supply signerCertChain.

content byte[ ] Conditional. The data (for example, the document that was originally signed) extracted from an implicit signature. If you are verifying a detached signature, content is not returned.

Note: The extracted data is returned in content even if signature verification fails.

signerInfo Document List Information about the signers. Each document in the list provides the following information about a single signer:

Key Description

certChain java.security.cert.X509Certificate[ ] Certificate chain of the signer. The chain will appear in hierarchical order, starting with the signer’s X.509 certificate in element 0.

timeStamp java.util.Date Time at which the signer signed the data.

trusted String Flag indicating whether the certificate chain presented by the signer is trusted.


pub.security.reverseInvoke:deleteAllConnections

pub.securi ty.reverseInvoke:deleteAl lConnect ionsWmPublic. Deletes all registration connections to a proxy server from an internal server.

Input Parameters

None.

Output Parameters

pub.securi ty.reverseInvoke:deleteConnect ionWmPublic. Deletes registered connections to a proxy server from an internal server.

Input Parameters

Output Parameters

pub.securi ty.reverseInvoke:disableListenersWmPublic. Disables specified listener on a proxy or relay server.

Input Parameters


true The chain is trusted.

false The chain is not trusted.

status String Flag indicating whether the signatures were successfully verified. If successful, status contains verified. If the signatures were not successfully verified, status contains an error message.

message String Text message indicating whether the connections were successfully removed or not.

alias String Remote connection alias to delete.

numConnections String Number of connections to delete. If you specify more connections than are registered, all connections for the alias are deleted.

numDeletedConnections String Number of connections that were deleted.

listenerType String Type of listener to disable.



Output Parameters

None.

pub.securi ty.reverseInvoke:getNumConnect ionsWmPublic. Gets number of connections to a proxy server. (For use on an internal server only.)

Input Parameters

Output Parameters

pub.securi ty.reverseInvoke:getServerTypeWmPublic. Reports the type that this server is running as.

Input Parameters

None.

Output Parameters

Set to... To...

proxy Disable the proxy listener.

registration Disable the relay listener.

alias String Alias of the proxy server for which you want to get the number of connections.

numConnections String Number of current connections to proxy server specified in alias.

serverType String Flag indicating the server’s type.


proxy The server is functioning as a proxy server.

relay The server is functioning as a relay server.

internal The server is functioning as an internal server.


pub.security.reverseInvoke:keepAliveConnections

pub.securi ty.reverseInvoke:keepAliveConnect ionsWmPublic. Creates the maximum number of configured connections to the proxy server.

(For use on an internal server only.) This service compares the number of actual connections to a proxy server to the number of connections that are configured for that server. If the number of actual connections is less than the number of configured connections, the service creates additional connections so that all configured connections are available.

Input Parameters

None.

Output Parameters

pub.securi ty.reverseInvoke: l istProxyListenersWmPublic. Lists the details about the proxy ports through which external clients make requests to the internal server. (For use on the reverse invoke server.)

Input Parameters

None.

Output Parameters

totalConnections String The resulting number of connections to the proxy server, including the number of existing connections and the number of connections the service created.

proxyListeners Document List Details about the proxy listeners. Each document in the list contains the following information about a proxy listener.

Key Description

port Object Port number on which the server is listening.

protocol String Protocol the internal service is using.


HTTP The connection is through HTTP.

HTTPS The connection is through HTTPS.

pkg String Name of the package to which this listener belongs.

enabled String Flag indicating whether the package in pkg is currently enabled.




true The package is enabled.

false The package is disabled.

key String Unique key for this listener.

hostAccessMode String Default access mode set on the proxy port.


include The port allows all hosts except those identified in hostDeny.

exclude The port denies all hosts except those identified in hostAllow.

hostAllow String List List of hosts that are allowed access to the listening port (if value of hostAccessMode is exclude).

hostDeny String List List of hosts that are denied access to the listening port (if value of hostAccessMode is include).

configURL String Name of the dynamic server page (dsp) that can be used to configure this proxy listener.

provider String Name of the entity that provided this listener (that is, webMethods).

listenerType String Type of listener the port functions as. The value will always be proxy, since this service returns information about a proxy listening port.

status String Flag indicating whether this proxy listener is active or inactive.


Active The listener is currently enabled.

Inactive The listener is currently disabled.

listening String Flag indicating whether this proxy listener is listening.


true The proxy listener is listening.

false The proxy listener is not listening.


pub.security.reverseInvoke:listRegisteredConnections

pub.securi ty.reverseInvoke:l istRegisteredConnect ionsWmPublic. Lists the connections to a proxy (when executed on an internal server) or lists the connections to an internal server (when executed on a proxy server).

Input Parameters

None.

Output Parameters

pub.securi ty.reverseInvoke:l istRegistrat ionListenersWmPublic. Lists the details about registration listeners that accept connections from internal servers (for use on the reverse invoke server).

Input Parameters

None.

registeredConnections Document List List of connections. Each document (IData) in registeredConnections has the following structure:

Key Description

remoteEndPoint String IP address and port of remote machine. If the connection is to a proxy server, this parameter is null.

secure String Flag indicating whether the connection is secure.


true The connection is secure.

false The connection is not secure.

isOpen String Flag indicating whether the connection is open.


true The connection is open.

false The connection is not open.

pendingRequests String Number of requests pending on this connection.

alias String Alias of the remote host. Returned only if the connection is to a proxy server.

totalRegisteredConnections String Total number of remote connections.

reqThreshold String Maximum number of pending requests per connection.



Output Parameters

registrationListeners Document List List of registration listeners. Each document (IData) in registrationListeners has the following structure:

port Object Port number of the listener.

protocol String Protocol used by listener.


SOCK The listener uses SOCK.

SSLSOCK The listener uses SSLSOCK.

pkg String Name of the package to which this listener belongs.

enabled String Flag indicating whether the package in pkg is currently enabled.


true The package is enabled.

false The package is disabled.

key String Unique key for this listener.

hostAccessMode String Default access mode set on the listening port.


include The port allows all hosts except those identified in hostDeny.

exclude The port denies all hosts except those identified in hostAllow.

hostAllow String List List of hosts that are allowed access to the listening port (if value of hostAccessMode is exclude).

hostDeny String List List of hosts that are denied access to the listening port (if value of hostAccessMode is include).

factoryKey String Key to the factory that is used to create this listener.

configURL String Name of the dynamic server page (dsp) that can be used to configure this listener.

provider String Name of the entity that provided this listener (that is, webMethods).

listenerType String Type of listener the port functions as. The value will always be Registration.

status String Flag indicating whether this listener is active.


pub.security.reverseInvoke:registerReverseConnections

pub.securi ty.reverseInvoke:registerReverseConnect ionsWmPublic. Registers connections to the proxy server.

Input Parameters

Output Parameters

pub.securi ty.ut i l :createMessageDigestWmPublic. Generates a message digest for a given message.

Input Parameters

Output Parameters


Active The listener is currently enabled.

Inactive The listener is currently disabled.

listening String Flag indicating whether this listener is listening.


true The listener is listening.

false The listener is not listening.

alias String Alias of the remote server on which connections will be registered.

numConnections String Number of connections to register.

message String Text message indicating whether the connections were successfully registered or not.

algorithm String Name of the algorithm that you want to use to compute the message digest. Must be either MD5 or SHA-1.

input byte[ ] Message for which you want the digest generated.

output byte[ ] Computed digest.



pub.securi ty.ut i l :getCert i f icateInfoWmPublic. Retrieves information such as serial number, issuer, and expiration date from a digital certificate.

Input Parameters

Output Parameters

certificate byte[ ] java.security.cert.X509Certificate The certificate whose information you want to retrieve.

info Document Information from the certificate.

Key Description

version java.lang.Number X509 certificate version number.

serialNumber String Serial number of the certificate.

signature String Signature algorithm used by the issuer to sign this certificate.

issuer Document Detailed information about the CA that signed the certificate, such as name, location, and email address.

validity Document The time period over which the certificate is valid.

Key Description

notBefore String First date on which this certificate is valid (for example, 3/15/00 3:36PM).

notAfter String Last date on which this certificate is valid (for example, 3/15/00 3:36PM).

subject Document Detailed information about the owner of the certificate, such as name, location, and email address.

subjectPublicKeyAlgorithm String Encryption algorithm with which the certificate’s key is designed to be used (for example, RSA or DSA).


pub.security.util:loadPKCS7CertChain

pub.securi ty.ut i l : loadPKCS7CertChainWmPublic. Converts a certificate chain that is in PKCS #7 format to a list of byte arrays.

Input Parameters

Output Parameters

certificateChain byte[ ] The certificate chain in PKCS #7 format.

certificates byte[ ] [ ] List of byte arrays in which each byte[ ] in the list contains a certificate from certificateChain.


C H A P T E R26
SMIME Folder
You use the elements in the smime folder to create digitally signed and/or encrypted MIME messages. You also use the services in this folder to process signed and encrypted MIME messages that are passed into the pipeline.


C H A P T E R 2 6 S M I M E F o l d e r


pub.smime:createCertsOnlyDataWmPublic. Generates a PKCS #7 certs-only S/MIME entity from an array of certificates.

This service can be used to develop mechanisms for transmitting certificates and certificate chains to other parties.

Input Parameters

Output Parameters

Usage Notes



pub.smime:createCertsOnlyData WmPublic. Generates a PKCS #7 certs-only S/MIME entity from an array of certificates.

pub.smime:createEncryptedData WmPublic. Encrypts a MIME message.

pub.smime:createSignedAndEncryptedData WmPublic. Digitally signs a MIME message and then encrypts it.

pub.smime:createSignedData WmPublic. Digitally signs a MIME message.

pub.smime:processCertsOnlyData WmPublic. Extracts the certificates from a PKCS #7 certs-only S/MIME entity.

pub.smime:processEncryptedData WmPublic. Decrypts an encrypted S/MIME message.

pub.smime:processSignedData WmPublic. Verifies the signature from a signed S/MIME entity and extracts the message from it.

certificates byte[ ][ ] The certificates that are to be encapsulated within the S/MIME entity. Each byte[ ] represents a single certificate.

SMimeEnvStream java.io.InputStream S/MIME entity.


pub.smime:createEncryptedData

pub.smime:createEncryptedDataWmPublic. Encrypts a MIME message.

Input Parameters

Output Parameters

Usage Notes


See Also

pub.smime:createSignedDatapub.smime:processEncryptedDatapub.mime:getEnvelopeStream

Examples

See the following in the WmSamples package:

sample.smime:build_EncryptedSMime

envStream java.io.InputStream MIME message that you want to encrypt (for example, the output produced by pub.mime:getEnvelopeStream).

recipientCerts byte[ ][ ] The X.509 certificates of the recipients for whom this message will be encrypted. Each element in the list represents a certificate for a single recipient in the form of a byte[ ].

Note: When you have multiple recipients, createEncryptedData creates a single message that is encrypted for all recipients. It does not create a separate message for each recipient.

encryptionAlg String Optional. Code specifying the encryption algorithm to use. Must be TripleDES (default), DES, or RC2.

keyLength String Optional. Length of the encryption key for RC2 encryption. Must be 40, 64, or 128 (default).

This parameter is ignored if encryptionAlg is not RC2.

SMimeEnvStream java.io.InputStream The encrypted MIME message.



pub.smime:createSignedAndEncryptedDataWmPublic. Digitally signs a MIME message and then encrypts it.

Important! You must use this service when you want to create a message that is both signed and encrypted. You cannot produce this type of message using the pub.smime:createSignedData and pub.smime:createEncryptedData services.

Input Parameters

envStream java.io.InputStream The MIME message that you want to sign and encrypt (for example, the output produced by pub.mime:getEnvelopeStream).

privKey byte[ ] Private key of the party signing the message.

certificates byte[ ] [ ] Optional. The certificate chain of the party signing the message, where each byte[ ] represents a single certificate in the chain. Certificates must appear in hierarchical order, starting with the signer’s certificate in element 0. The following list shows how the elements of a complete chain would appear for a certificate that was issued through two intermediate CAs:

Element Contents

0 Signer’s certificate.

1 Intermediary CA Certificate.


3 Root CA Certificate.

Note: Although this parameter is optional, it should only be omitted if the party receiving the message is able to process this signature without an accompanying certificate chain.

signerCert byte[ ] Digital certificate of the party signing the message.


Set to... To...



recipientCerts byte[ ][ ] X.509 certificates of the recipients for whom this message will be encrypted. Each element in the list contains the certificate for a single recipient in the form of a byte array.

encryptionAlg String Optional. Code specifying the encryption algorithm to use. Must be TripleDES (default), DES, or RC2.


pub.smime:createSignedData

Output Parameters

Usage Notes


See Also

pub.smime:createEncryptedDatapub.smime:processEncryptedDatapub.smime:createSignedDatapub.smime:processSignedDatapub.mime:getEnvelopeStream

Examples


sample.smime:build_SignedAndEncryptedSMime

pub.smime:createSignedDataWmPublic. Digitally signs a MIME message.

Input Parameters

keyLength String Optional. Length of the encryption key for RC2 encryption. Must be 40, 64, or 128 (default).

This parameter is ignored if encryptionAlg is not RC2.

SMimeEnvStream java.io.InputStream Signed and encrypted MIME message.

envStream java.io.InputStream MIME message that you want to sign (for example, the output produced by pub.mime:getEnvelopeStream).

privKey byte[ ] Private key of the party signing the message.

certificates byte[ ][ ] Optional. Certificate chain of the party that signed the message, where each byte[ ] represents a single certificate in the chain. Certificates must appear in hierarchical order, starting with the signer’s certificate in element 0. The following shows how the elements of a complete chain would appear for a certificate that was issued through two intermediate CAs:

Element Contents





Output Parameters

Usage Notes


See Also

pub.smime:createEncryptedDatapub.mime:getEnvelopeStream

Examples


sample.smime:build_SignedSMime

pub.smime:processCertsOnlyDataWmPublic. Extracts the certificates from a PKCS #7 certs-only S/MIME entity.

Input Parameters

Output Parameters



Although this parameter is optional, it should only be omitted if the party receiving the message is able to process this signature without an accompanying certificate chain.

signerCert byte[ ] Digital certificate of the party signing the message.

explicit String Optional. Flag indicating whether an implicit or explicit signature is generated.

Set to... To...



SMimeEnvStream java.io.InputStream The signed MIME message.

SMimeEnvStream java.io.InputStream The certs-only S/MIME entity.

certificates byte[ ][ ] The extracted certificates. Each element in the list contains one of the extracted certificates represented as a byte[ ].


pub.smime:processEncryptedData

pub.smime:processEncryptedDataWmPublic. Decrypts an encrypted S/MIME message.

Input Parameters

Output Parameters

Usage Notes

If the decrypted message is signed or encrypted, mimeData will be empty, and the decrypted message will reside in stream. You can check the state of the signed and encrypted output variables to determine

SMimeEnvStream java.io.InputStream The encrypted S/MIME entity (for example, the output produced by pub.smime:createEncryptedData).

recipientCert byte[ ] Digital certificate of the party receiving the message.

privKey byte[ ] Private key of the party receiving the message (that is, the party whose public key was used to encrypt the message).

mimeData Document MIME object containing the decrypted MIME message.

contentDigest String Message digest of the encrypted content, base64-encoded. (Some sites return this digest to the sender to acknowledge their receipt of the message.)

encrypted String Conditional. Flag indicating whether the decrypted MIME entity is encrypted.




signed String Conditional. Flag indicating whether the decrypted MIME entity is signed.




certsOnly String Conditional. Flag indicating whether the decrypted MIME entity is a certs-only entity.




stream java.io.InputStream Conditional. The decrypted MIME entity.



whether the decrypted message requires additional processing, and pass stream to the pub.smime:processSignedData or pub.smime:processEncryptedData service as necessary.

Important! You can examine the contents of mimeData during testing and debugging. However, because the internal structure of mimeData is subject to change without notice, do not explicitly set or map data to/from these elements in your service. To manipulate or access the contents of mimeData, use only the MIME services that webMethods provides.

See Also

pub.smime:processSignedDatapub.smime:createEncryptedData

Examples


sample.smime:extract_EncryptedSMimesample.smime:extract_SignedAndEncryptedSMime

pub.smime:processSignedDataWmPublic. Verifies the signature from a signed S/MIME entity and extracts the message from it.

Input Parameters

Output Parameters

SMimeEnvStream java.io.InputStream Signed MIME entity (for example, the output produced by pub.smime:createSignedData).

signerCertChain byte[ ][ ] Optional. Certificate chain of the party that signed the message, where each byte[ ] represents a single certificate in the chain. Certificates must appear in hierarchical order, starting with the signer’s certificate in element 0. The following shows how the elements of a complete chain would appear for a certificate that was issued through two intermediate CAs:

Element Contents





Note: If the signer included the certificate chain with the digital signature, you do not need to supply signerCertChain.

mimeData Document MIME object containing the extracted MIME entity.


pub.smime:processSignedData

contentDigest String Message digest (base64-encoded) that was recalculated by processSignedData.

signerCert java.security.cert.X509Certificate Signer’s X.509 certificate.

encrypted String Conditional. Flag indicating whether the extracted MIME entity is encrypted.




signed String Conditional. Flag indicating whether the extracted MIME entity is signed.




certsOnly String Conditional. Flag indicating whether the extracted MIME entity is a certs-only entity.




stream java.io.InputStream Conditional. Extracted MIME entity.

verify String Flag indicating whether the signature was successfully processed. Success indicates that the signature was successfully verified with the supplied public key.


true Signature processing was successful.

false Signature processing failed. The signature could not be verified because an errorCode 1, 2, 3, or 4 occurred.

trusted String Flag indicating whether the signer certificate is trusted or not.


true The signer certificate is trusted.

false The signer certificate is not trusted.

errorCode String Conditional. Number indicating the kind of error that occurred while processing the signature. See errorMessage for possible values.

If no error occurred, errorCode will not be returned.

errorMessage String Conditional. Textual error message indicating what kind of error occurred while processing the signature. Error codes and messages are as follows:



Usage Notes

If verify is false, the errorCode and errorMessage values will indicate the error that caused the failure. Note that errorCode values 5 through 7 do not represent signature-validation failures and, therefore, do not cause the verify flag to be set to false.

If the extracted entity is signed or encrypted, mimeData will be empty, and the extracted entity will reside in stream. You can check the state of the signed and encrypted output variables to determine whether the extracted entity requires additional processing, and pass stream to the pub.smime:processEncryptedData service as necessary.

Important! You can examine the contents of mimeData during testing and debugging. However, because the internal structure of mimeData is subject to change without notice, do not explicitly set or map data to/from these elements in your service. To manipulate or access the contents of mimeData, use only the MIME services that webMethods provides.

See Also

pub.smime:processEncryptedDatapub.smime:createSignedData

Examples


sample.smime:extract_SignedSMimesample.smime:extract_SignedAndEncryptedSMime

errorCode errorMessage

1 Invalid signer certificate file information.

2 Certificate at index ‘i’ is not in recognizable format.

3 Invalid certificate input at index ‘i’.

4 Signature cannot be verified.

5 Expired certificate chain.

6 Error in certificate chain.

7 Untrusted certificate.


C H A P T E R27
SOAP Folder
You use the elements in the soap folder to compose and send SOAP messages and to receive and retrieve data from within them. You also use SOAP services to register custom SOAP processors.


C H A P T E R 2 7 S O A P F o l d e r



pub.soap.processor:list WmPublic. Returns a list of the SOAP processors that are currently registered on the Integration Server.

pub.soap.processor:processMessage WmPublic. Executes the Integration Server’s default SOAP processor.

pub.soap.processor:processRPCMessage WmPublic. Executes the Integration Server’s SOAP RPC processor.

pub.soap.processor:registerProcessor WmPublic. Registers a service as a SOAP processor on the Integration Server.

pub.soap.processor:unregisterProcessor WmPublic. Unregisters a SOAP processor by removing it from the registry.

pub.soap.schema:encoding WmPublic. Schema that defines the data types SOAP supports.

pub.soap.schema:envelope WmPublic. Schema that defines the structure of a SOAP message.

pub.soap.utils:addBodyEntry WmPublic. Inserts an entry into the body element of a SOAP message.

pub.soap.utils:addHeaderEntry WmPublic. Inserts an entry into the header element of a SOAP message.

pub.soap.utils:addTrailer WmPublic. Inserts a trailer in a SOAP message.

pub.soap.utils:createSoapData WmPublic. Creates an empty SOAP object.

pub.soap.utils:exitUnableToUnderstand WmPublic. Terminates processing and returns a mustUnderstand fault to the client.

pub.soap.utils:getActor WmPublic. Retrieves the value of the actor attribute from a given header entry.

pub.soap.utils:getBody WmPublic. Retrieves the body from a SOAP message as a single node object.

pub.soap.utils:getBodyEntries WmPublic. Retrieves the body entries from a SOAP message as an array of node objects.

pub.soap.utils:getDocument WmPublic. Retrieves an entire SOAP message as a node object.

pub.soap.utils:getHeader WmPublic. Retrieves the header from a SOAP message as a single node object.


pub.soap.processor:list

pub.soap.processor: l istWmPublic. Returns a list of the SOAP processors that are currently registered on the Integration Server.

Input Parameters

None.

Output Parameters

pub.soap.utils:getHeaderEntries WmPublic. Retrieves the header entries from a SOAP message as an array of node objects.

pub.soap.utils:getMustUnderstand WmPublic. Returns the mustUnderstand status for a given header entry.

pub.soap.utils:getQName WmPublic. Returns the qualified name for a given node.

pub.soap.utils:getTrailers WmPublic. Retrieves the trailers from a SOAP message.

pub.soap.utils:QName WmPublic. Document type that defines the structure of a qualified name.

pub.soap.utils:removeBodyEntry WmPublic. Deletes a body entry from a SOAP message.

pub.soap.utils:removeHeaderEntry WmPublic. Deletes a header entry from a SOAP message.

pub.soap.utils:removeTrailer WmPublic. Deletes a trailer from a SOAP message.

pub.soap.utils:requestResponseSpec WmPublic. Defines the input/output signature for a custom processor and a target service for the default processor.

pub.soap.utils:soapDataToString WmPublic. Converts a SOAP object to a String.

pub.soap.utils:streamToSoapData WmPublic. Converts an InputStream containing a SOAP message to a SOAP object.

pub.soap.utils:stringToSoapData WmPublic. Converts a String containing a SOAP message to a SOAP object.

pub.soap.utils:validateSoapData WmPublic. Verifies that a SOAP object represents a valid SOAP message.


list Document List List of processors currently registered on the server. Each document in the list contains the following information:

Key Description

directive String Process directive that is assigned to the SOAP processor.



See Also

pub.soap.processor:registerProcessorpub.soap.processor:unregisterProcessor

pub.soap.processor:processMessage WmPublic. Executes the Integration Server’s default SOAP processor.

This service behaves exactly like the built-in default SOAP processor. However, this service can be wrapped in a flow service, which enables you to create an access-controlled SOAP processor. For

svcName String Fully qualified name of the service that functions as the SOAP processor.

descriptiveName String Descriptive comment that was given to the SOAP processor when it was registered. This element will be empty if the processor was not registered with a descriptive comment.

validateSOAPMessage String Flag indicating whether the SOAP message handler validates the SOAP messages that this processor sends and receives.


true Messages are validated by the SOAP message handler. Be aware that the validation process checks only that the message envelope is structured correctly. For example, it checks the message has at least one body element and there is at most one header element. It does not validate any of the data carried by the message.

This setting overrides the server’s global watt.server.SOAP.validateSOAPMessage setting.

false Messages are not validated by the SOAP message handler.


If validateSOAPMessage is null, message validation for the processor is determined by the server’s watt.server.SOAP.validateSOAPMessage setting.


pub.soap.processor:processRPCMessage

information about creating and registering access-controlled SOAP processors, see the SOAP Developer’s Guide.

Input Parameters

Output Parameters

Usage Notes

You invoke processMessage from a wrapper service that you create and register as a SOAP processor on the Integration Server. To impose access control on the processor, you assign an access control list (ACL) to the wrapper service. For information about how to use this service, see the SOAP Developer’s Guide.

pub.soap.processor:processRPCMessage WmPublic. Executes the Integration Server’s SOAP RPC processor.

This service behaves exactly like the built-in SOAP RPC processor. However, this service can be wrapped in a flow service, which enables you to create an access-controlled SOAP processor. For information about creating and registering access-controlled SOAP processors, see the SOAP Developer’s Guide.

Input Parameters

Output Parameters

Usage Notes

You invoke processRPCMessage from a wrapper service that you create and register as a SOAP processor on the Integration Server. To impose access control on the processor, you assign an access

soapRequestData Object SOAP object containing the SOAP request submitted to the Integration Server by a client.

soapResponseData Object Empty SOAP object that the service will use to compose the SOAP response message.

soapResponseData Object SOAP object containing the SOAP response message that is to be returned to the client.

soapRequestData Object SOAP object containing the SOAP request submitted to the Integration Server by a client.

soapResponseData Object Empty SOAP object that the service will use to compose the SOAP response message.

soapResponseData Object SOAP object containing the SOAP response message that is to be returned to the client.



control list (ACL) to the wrapper service. For information about how to use this service, see the SOAP Developer’s Guide.

pub.soap.processor:registerProcessorWmPublic. Registers a service as a SOAP processor on the Integration Server.

Input Parameters

Output Parameters

None.

directive String Process directive that you want to assign to the SOAP processor.

Note: Use only letters, digits, or the characters -_.!~*'( ) in the name you specify in directive.

svcName String Fully qualified name of the service that you are registering as a SOAP processor.

descriptiveName String Descriptive comment for this SOAP processor. This comment is shown when you run the utility service pub.soap.processor:list to get a list of the registered SOAP processors.

validateSOAPMessage String Optional. Flag indicating whether the SOAP message handler validates the SOAP messages that this processor sends and receives.

Set to... To...

true Validate messages sent and received by this SOAP processor. Be aware that the validation process checks only that the message envelope is structured correctly. For example, it checks the message has at least one body element and there is at most one header element. It does not validate any of the data carried by the message.


false Bypass validation on messages sent and received by this SOAP processor.


Or, leave validateSOAPMessage null to validate messages according to the Integration Server’s watt.server.SOAP.validateSOAPMessage setting. This is the default.


pub.soap.processor:unregisterProcessor

Usage Notes

For information about creating and registering SOAP processors, see the SOAP Developer’s Guide.

See Also

pub.soap.processor:listpub.soap.processor:unregisterProcessor

Examples


sample.soap:registerProcessor

pub.soap.processor:unregisterProcessorWmPublic. Unregisters a SOAP processor by removing it from the registry.

Input Parameters

Output Parameters

None.

Usage Notes

If the directive specified in directive is not registered on the Integration Server, unregisterProcessor throws an exception.

See Also

pub.soap.processor:listpub.soap.processor:registerProcessor

directive String Process directive that you want to remove from the registry. Directive names are case sensitive.

Tip! To obtain a list of the current SOAP processor directives registered on the server, run the pub.soap.processor:list service.



pub.soap.schema:encodingWmPublic. Schema that defines the data types SOAP supports.

pub.soap.schema:envelopeWmPublic. Schema that defines the structure of a SOAP message.

pub.soap.ut i ls:addBodyEntryWmPublic. Inserts an entry into the body element of a SOAP message.

Input Parameters

Output Parameters

Usage Notes

A SOAP object is an object that represents a SOAP message.

If you are composing a new SOAP message, you must first create an empty SOAP object (called soapData) with the pub.soap.utils:createSoapData service and then add body entries to with addBodyEntry.

If you are composing a SOAP response, you use pub.soap.utils:addBodyEntry to populate the soapResponseData object that the SOAP message handler generates and puts in the pipeline.

For information about composing SOAP messages, see the SOAP Developer’s Guide.

soapData Object SOAP object to which you want the body entry added.

bodyEntry com.wm.lang.xml.Node XML node containing the body entry that you want to add to soapData.

Note: An XML node is a parsable representation of a node in an XML document. You generate an XML node using services such as pub.xml:xmlStringToXMLNode.

Important! This service adds a single body entry to a SOAP object. If you need to add more than one entry, execute pub.soap.utils:addBodyEntry once for each entry.

Important! In webMethods versions 6.0.1 and later, this service expects the node in bodyEntry to be namespace qualified. If the node is not qualified, the service throws an exception. If you created solutions based on the earlier behavior of this service (which permitted non-qualified entries), you can disable namespace enforcement by setting the server’s watt.server.SOAP.EnforceMsgPartNS parameter to false. For information about this parameter, see the SOAP Developer’s Guide

soapData Object SOAP object to which the body entry was added.


pub.soap.utils:addHeaderEntry

See Also

pub.soap.utils:createSoapDatapub.soap.utils:addBodyEntrypub.soap.utils:addHeaderEntrypub.soap.utils:addTrailerpub.soap.utils:getBodypub.soap.utils:getBodyEntries

Examples


sample.soap:buildMsg_sendHTTPsample.soap:customProc_msgQuwuesample.soap:targetSvc_defaultProc

pub.soap.ut i ls:addHeaderEntryWmPublic. Inserts an entry into the header element of a SOAP message.

Input Parameters

soapData Object SOAP object to which you want the header entry added.

headerEntry com.wm.lang.xml.Node XML node containing the entry that you want to add to soapData.


Important! This service adds a single header entry to a SOAP object. If you need to add more than one entry, execute addHeaderEntry once for each entry.

Important! In webMethods versions 6.0.1 and later, this service expects the node in headerEntry to be namespace qualified. If the node is not qualified, the service throws an exception. If you created solutions based on the earlier behavior of this service (which permitted non-qualified entries), you can disable namespace enforcement by setting the server’s watt.server.SOAP.EnforceMsgPartNS parameter to false. For information about this parameter, see the SOAP Developer’s Guide.

mustUnderstand String Optional. Value to which you want the mustUnderstand attribute set.

The mustUnderstand attribute specifies whether recipients are required to process a header entry (that is, whether processing of the entry is mandatory or optional). Recipients that cannot process a mandatory header entry must reject the message and return a SOAP fault.



Output Parameters

Usage Notes


If you are composing a new SOAP message, you must first create an empty SOAP object (called soapData) with the pub.soap.utils:createSoapData service and then add your header entries to with addHeaderEntry.

If you are composing a SOAP response, you use addHeaderEntry to populate the soapResponseData object that the SOAP message handler generates and puts in the pipeline.


See Also

pub.soap.utils:createSoapDatapub.soap.utils:addBodyEntrypub.soap.utils:addTrailerpub.soap.utils:getHeaderpub.soap.utils:getHeaderEntries

Examples


sample.soap:buildMsg_sendHTTP sample.soap:targetSvc_defaultProc


0 The header is optional.

1 The header is mandatory.

For additional information about the mustUnderstand attribute, see the Simple Object Access Protocol (SOAP) 1.1 - W3C Note 08 May 2000 at http://www.w3.org/TR/SOAP/.

Note: If you do not set mustUnderstand, the mustUnderstand attribute is omitted from the header entry, which is equivalent to setting mustUnderstand to 0.

actor String Optional. Value to which you want the actor attribute set.

The actor attribute specifies a URI that identifies the recipient to which a header entry is targeted. For additional information about the mustUnderstand attribute, see the Simple Object Access Protocol (SOAP) 1.1 - W3C Note 08 May 2000 at http://www.w3.org/TR/SOAP/.

soapData Object SOAP object to which the header entry was added.


http://www.w3.org/TR/SOAP/

pub.soap.utils:addTrailer

pub.soap.ut i ls:addTrai lerWmPublic. Inserts a trailer in a SOAP message.

(A trailer is an arbitrary element that follows the Body element in the SOAP envelope.)

Important! It appears likely that trailers will not be permitted in future versions of SOAP (versions 1.2 and later). If you are designing a completely new solution, we recommend that you avoid using trailers. However, if you exchange SOAP messages with older systems that already make use of trailers, this service allows you to insert them into a SOAP message.

Input Parameters

Output Parameters

Usage Notes


If you are composing a new SOAP message, you must first create an empty SOAP object (called soapData) with the createSoapData service and then add your header entries to with pub.soap.utils:addHeaderEntry.

If you are composing a SOAP response, you use pub.soap.utils:addHeaderEntry to populate the soapResponseData object that the SOAP message handler generates and puts in the pipeline.


See Also

pub.soap.utils:createSoapDatapub.soap.utils:addHeaderEntrypub.soap.utils:addBodyEntrypub.soap.utils:getTrailers

soapData Object SOAP object to which you want the trailer added.

trailer com.wm.lang.xml.Node XML node containing the trailer that you want to add to soapData.


Important! This service adds a single trailer to a SOAP object. If you need to insert more than one trailer in the message, execute addTrailer once for each trailer that needs to be added.

Note: The SOAP specification states that trailers must be namespace qualified, so be sure that the node in trailer specifies a namespace.

soapData Object SOAP object to which the trailer was added.



pub.soap.ut i ls:createSoapDataWmPublic. Creates an empty SOAP object.

To compose a new SOAP message, you first use this service to create an empty SOAP object, and then you add content to the SOAP object using services such as pub.soap.utils:addHeaderEntry and pub.soap.utils:addBodyEntry.

Input Parameters

None.

Output Parameters

Usage Notes


See Also

pub.soap.utils:addHeaderEntrypub.soap.utils:addBodyEntrypub.soap.utils:addTrailer

Examples


sample.soap:buildMsg_sendHTTP

pub.soap.ut i ls:exi tUnableToUnderstandWmPublic. Terminates processing and returns a mustUnderstand fault to the client.

You execute this service when your SOAP processor detects a mandatory header entry that it cannot process.

Input Parameters

Output Parameters

None.

soapData Object Empty SOAP object.

headerEntry com.wm.lang.xml.Node XML node containing the header entry that cannot be understood.


pub.soap.utils:getActor

Usage Notes

This service throws an exception, which is meant to be caught by the message handler so that the appropriate SOAP fault will be returned to the client. Your processor should not catch this exception.

pub.soap.ut i ls:getActorWmPublic. Retrieves the value of the actor attribute from a given header entry.

Input Parameters

Output Parameters

Usage Notes

For general information about the SOAP header entries and attributes, see the SOAP Developer’s Guide.

See Also

pub.soap.utils:addHeaderEntrypub.soap.utils:getMustUnderstandpub.soap.utils:getHeaderpub.soap.utils:getHeaderEntries

pub.soap.ut i ls:getBodyWmPublic. Retrieves the body from a SOAP message as a single node object.

Input Parameters

headerEntry com.wm.lang.xml.Node The header entry whose actor value you want to retrieve.

If you use pub.soap.utils:getHeaderEntries to retrieve header entries, you can loop over the list of header nodes to retrieve the actor value from each entry.

If you use pub.soap.utils:getHeader to retrieve header entries, you will need to query the node returned by that service (using the pub.xml:queryXMLNode service) to extract a node for an individual header entry. Then you can run getActor on the resulting node.

actor String Value of the header entry’s actor attribute. If the header entry does not have an actor attribute, actor will be null.

soapData Object SOAP object containing the message whose Body node you want to retrieve.



Output Parameters

Usage Notes

This service returns the entire Body element in body. To extract data from the Body element, query body with the pub.xml:queryXMLNode service.

If you want to extract the body of the message as an array of nodes, use the pub.soap.utils:getBodyEntries service.

For additional information about extracting information from SOAP messages, see the SOAP Developer’s Guide.

See Also

pub.soap.utils:getBodyEntriespub.soap.utils:addBodyEntry

Examples


sample.soap:buildMsg_sendHTTPsample.soap:customProc_msgQueuesample.soap:targetSvc_defaultProc

pub.soap.ut i ls:getBodyEntr iesWmPublic. Retrieves the body entries from a SOAP message as an array of node objects.

Input Parameters

Output Parameters

Usage Notes

This service returns each body entry as a separate node. You can loop over bodyEntries and extract data from each node with the pub.xml:queryXMLNode service.

If you want to extract the body of the message as a single node, use the pub.soap.utils:getBody service.

body com.wm.lang.xml.Node The Body node from the SOAP message (that is, <SOAP-ENV:Body> to </SOAP-ENV:Body>).

soapData Object The SOAP object containing the message whose body entries you want to retrieve.

bodyEntries com.wm.lang.xml.Node[ ] An array of XML nodes, where each node represents a body entry from the message.


pub.soap.utils:getDocument


See Also

pub.soap.utils:getBodypub.soap.utils:addBodyEntry

pub.soap.ut i ls:getDocumentWmPublic. Retrieves an entire SOAP message as a node object.

This service is useful when you want to use pub.xml:queryXMLNode to query an entire SOAP message. Since queryXMLNode requires a node as input, you cannot use it to query a SOAP object directly. Instead, you must convert the SOAP object to a node and then query the resulting node.

Input Parameters

Output Parameters

Usage Notes


See Also

pub.soap.utils:getBodypub.soap.utils:getBodyEntriespub.soap.utils:getHeaderpub.soap.utils:getHeaderEntriespub.soap.utils:getTrailers

pub.soap.ut i ls:getHeaderWmPublic. Retrieves the header from a SOAP message as a single node object.

Input Parameters

soapData Object SOAP object for which you want a node representation.

node com.wm.lang.xml.Node Node representation of the entire SOAP message in soapData (that is, <SOAP-ENV:Envelope> to </SOAP-ENV:Envelope>.

soapData Object SOAP object containing the message whose Header node you want to retrieve.



Output Parameters

Usage Notes

This service returns the entire Header element in header. To extract data from the Header element, query header with the pub.xml:queryXMLNode service.

If you want to extract the contents of the header as an array of nodes, use the pub.soap.utils:getHeaderEntries service.


See Also

pub.soap.utils:getHeaderEntriespub.soap.utils:getBodypub.soap.utils:getBodyEntriespub.soap.utils:getTrailerspub.soap.utils:addHeaderEntry

Examples


sample.soap:customProc_msgQueue

pub.soap.ut i ls:getHeaderEntr iesWmPublic. Retrieves the header entries from a SOAP message as an array of node objects.

This service is useful when you want to build a process that loops through all the header entries in a message and identify entries with specific QNames (using the pub.soap.utils:getQName service) or actor attributes (using the pub.soap.utils:getActor service).

Input Parameters

Output Parameters

header com.wm.lang.xml.Node Header node from the SOAP message (that is, <SOAP-ENV:Header> to </SOAP-ENV:Header>).

soapData Object SOAP object containing the message whose header entries you want to retrieve.

headerEntries com.wm.lang.xml.Node[ ] Header entries from the SOAP message. Each node in the array represents a header entry from the message.


pub.soap.utils:getMustUnderstand

Usage Notes

This service returns each header entry as a separate node. You can loop over headerEntries and extract data from each node with the pub.xml:queryXMLNode service or get the entry’s QName and/or actor value using the pub.soap.utils:getQName and pub.soap.utils:getActor services.

If you want to extract the message header as a single node, use the pub.soap.utils:getHeader service.


See Also

pub.soap.utils:getHeaderpub.soap.utils:getBodypub.soap.utils:getBodyEntriespub.soap.utils:getDocumentpub.soap.utils:addHeaderEntrypub.soap.utils:getActorpub.soap.utils:getQName

pub.soap.ut i ls:getMustUnderstandWmPublic. Returns the mustUnderstand status for a given header entry.

The mustUnderstand status specifies whether recipients are required to process a header entry (that is, whether processing of the entry is mandatory or optional). Recipients that cannot process a mandatory header entry must reject the message and return a SOAP fault. (See the pub.soap.utils:exitUnableToUnderstand service.)

Input Parameters

headerEntry com.wm.lang.xml.Node The header entry whose mustUnderstand status you want to retrieve.

If you use pub.soap.utils:getHeaderEntries to retrieve header entries, you can loop over the list of header nodes to check the status of each entry.

If you use pub.soap.utils:getHeader to retrieve header entries, you will need to query the node returned by that service (using the pub.xml:queryXMLNode service) to extract a node for an individual header entry. Then you can run pub.soap.utils:getMustUnderstand on the resulting node.



Output Parameters

Usage Notes

For additional information about the mustUnderstand attribute, see the Simple Object Access Protocol (SOAP) 1.1 - W3C Note 08 May 2000 at http://www.w3.org/TR/SOAP/ and the SOAP Developer’s Guide.

See Also

pub.soap.utils:addHeaderEntrypub.soap.utils:getActorpub.soap.utils:getHeaderpub.soap.utils:getHeaderEntriespub.soap.utils:exitUnableToUnderstand

pub.soap.ut i ls:getQNameWmPublic. Returns the qualified name for a given node.

Input Parameters

Output Parameters

Usage Notes

Generally, you use this service in conjunction with the pub.soap.utils:getHeaderEntries or pub.soap.utils:getBodyEntries service to loop over the message’s header or body entries and identify entries with a particular qualified name.

mustUnderstand String Header entry’s mustUnderstand status. If the header entry has a mustUnderstand attribute, mustUnderstand will return one of the following values:


0 The header is optional.

1 The header is mandatory.

If the header entry does not have a mustUnderstand attribute, mustUnderstand will return 0.

node com.wm.lang.xml.Node The XML node whose qualified name you want to discover.

Qname Document The node’s qualified name. Qname will contain the following keys:

Key Description

namespaceName String Namespace portion of the node’s qualified name.

localName String Local portion of the node’s qualified name.


http://www.w3.org/TR/SOAP/

pub.soap.utils:getTrailers

See Also

pub.soap.utils:getBodyEntriespub.soap.utils:getHeaderEntries

pub.soap.ut i ls:getTrai lersWmPublic. Retrieves the trailers from a SOAP message.

(A trailer is an arbitrary element that follows the Body element in the SOAP envelope.)

Important! It appears likely that trailers will not be permitted in future versions of SOAP (versions 1.2 and later). If you are designing a completely new solution, we recommend that you avoid using trailers. However, if you exchange SOAP messages with older systems that already make use of trailers, this service allows you to retrieve them from a SOAP message.

Input Parameters

Output Parameters

See Also

pub.soap.utils:addTrailerpub.soap.utils:getHeaderpub.soap.utils:getHeaderEntriespub.soap.utils:getBodypub.soap.utils:getBodyEntriespub.soap.utils:getDocument

pub.soap.ut i ls:QNameWmPublic. Document type that defines the structure of a qualified name.

Parameters

soapData Object SOAP object containing the message whose trailers you want to retrieve.

trailers com.wm.lang.xml.Node[ ] Array of nodes wherein each node represents a trailer from the message. If the message does not contain trailers, trailers will be null.

namespaceName String The namespace portion of a qualified name.

localName String The local portion of a qualified name.



pub.soap.ut i ls:removeBodyEntryWmPublic. Deletes a body entry from a SOAP message.

Input Parameters

Output Parameters

None.

Usage Notes

When you use the bodyEntry parameter, be sure that it specifies the correct node. This service deletes whatever node is specified in bodyEntry, even if the node is not a body entry. For example, if bodyEntry contains the whole Body element, removeBodyEntry will delete the body of the message.

Note: Be aware that if you use the index parameter to delete an entry, you will change the index numbers (positions) of all entries following the one you deleted. For example, if your message contains four body entries (0, 1, 2, 3) and you delete entry 1, then the entries originally at positions 2 and 3 will subsequently occupy positions 1 and 2.

See Also

pub.soap.utils:removeHeaderEntrypub.soap.utils:removeTrailerpub.soap.utils:addBodyEntrypub.soap.utils:getBodypub.soap.utils:getBodyEntries

pub.soap.ut i ls:removeHeaderEntryWmPublic. Deletes a header entry from a SOAP message.

Input Parameters

soapData Object SOAP object containing the body entry that you want to delete.

bodyEntry com.wm.lang.xml.Node Optional. The entry that you want to remove from soapData. (You would obtain the node with the pub.soap.utils:getBodyEntries service.)

Note: You can use bodyEntry or index to specify the entry that you want removeBodyEntry to delete.

index String Optional. Index of the entry that you want to remove (where index 0 represents the first body entry). index is ignored if bodyEntry is specified.

soapData Object SOAP object containing the header entry that you want to delete.


pub.soap.utils:removeTrailer

Output Parameters

None.

Usage Notes

When you use the headerEntry parameter, be sure that it specifies the correct node. This service deletes whatever node is specified in headerEntry, even if the node is not a header entry. For example, if headerEntry contains the whole Header element, removeHeaderEntry will delete the entire header from the message.

Note: Be aware that if you use the index parameter to delete an entry, you will change the index numbers (positions) of all entries following the one you deleted. For example, if your header contains four entries (0, 1, 2, 3) and you delete entry 1, then the entries originally at positions 2 and 3 will subsequently occupy positions 1 and 2.

See Also

pub.soap.utils:removeBodyEntrypub.soap.utils:removeTrailerpub.soap.utils:addHeaderEntrypub.soap.utils:getHeaderpub.soap.utils:getHeaderEntries

pub.soap.ut i ls:removeTrai lerWmPublic. Deletes a trailer from a SOAP message.

Input Parameters

headerEntry com.wm.lang.xml.Node Optional. The header entry that you want to remove from soapData. (You would obtain the node with the pub.soap.utils:getHeaderEntries service.)

Note: You can use headerEntry or index to specify the entry that you want removeHeaderEntry to delete.

index String Optional. Index of the entry that you want to remove (where index 0 represents the first header entry). index is ignored if headerEntry is specified.

soapData Object SOAP object containing the trailer that you want to delete.

trailer com.wm.lang.xml.Node Optional. The trailer that you want to remove from soapData. (You would obtain the node with the pub.soap.utils:getTrailers service.)

Note: You can use trailer or index to specify the trailer that you want removeTrailer to delete.

index String Optional. Index of the trailer that you want to remove (where index 0 represents the first trailer). index is ignored if trailer is specified.



Output Parameters

None.

Usage Notes

When you use the trailer parameter, be sure that it specifies the correct node. This service deletes whatever node is specified in trailer, even if the node is not a trailer. For example, if trailer contains the Body element, removeTrailer will delete the entire body of the message.

Note: Be aware that if you use the index parameter to delete a trailer, you will change the index numbers (positions) of all trailers following the one you deleted. For example, if your message contains four trailers (0, 1, 2, 3) and you delete trailer 1, then the trailers originally at positions 2 and 3 will subsequently occupy positions 1 and 2.

See Also

pub.soap.utils:removeHeaderEntrypub.soap.utils:removeBodyEntrypub.soap.utils:addTrailerpub.soap.utils:getTrailers

pub.soap.ut i ls:requestResponseSpecWmPublic. Defines the input/output signature for a custom processor and a target service for the default processor.

Input Parameters

Output Parameters

Examples


sample.soap:customProc_msgQueuesample.soap:targetSvc_defaultProc

soapRequestData Object SOAP object containing the SOAP request submitted to the Integration Server by the client.

soapResponseData Object Empty SOAP object that the custom processor or target service uses to compose the SOAP response message.

soapResponseData Object SOAP object containing the message that is to be returned to the client.


pub.soap.utils:soapDataToString

pub.soap.ut i ls:soapDataToStr ingWmPublic. Converts a SOAP object to a String.

This is useful when you want to use the message with a process that requires the message to be in the form of a String.

Input Parameters

Output Parameters

See Also

pub.soap.utils:streamToSoapDatapub.soap.utils:stringToSoapData

pub.soap.ut i ls:streamToSoapDataWmPublic. Converts an InputStream containing a SOAP message to a SOAP object.

(A SOAP message must be represented as a SOAP object to be used with the data-retrieval services such as pub.soap.utils:getHeader and pub.soap.utils:getBody).

Note: This service is a convenient way to produce a SOAP object during development and testing. It is not meant to be used for production purposes because it does not ensure that a valid SOAP message is produced. For production purposes, we recommend that you create SOAP objects with the pub.soap.utils:createSoapData service and populate them with the message-composition services (for example, pub.soap.utils:addBodyEntry and pub.soap.utils:addHeaderEntry).

Input Parameters

Output Parameters

Usage Notes

Be aware that if stream does not contain a valid SOAP message, this service does not throw an exception. Instead, it produces a soapData that contains a representation of whatever it received in stream (which might not even be an XML document). This will cause problems later when you attempt to use the soapData with other SOAP utilities or pass it to the message handler. To determine whether

soapData Object SOAP object that you want to convert to a String.

string String Entire SOAP message.

stream java.io.InputStream SOAP message that is to be converted to a SOAP object.

soapData Object SOAP object representation of the SOAP message in stream.



soapData represents a valid SOAP message, we recommend that you always execute the pub.soap.utils:validateSoapData service immediately after using streamToSoapData.

See Also

pub.soap.utils:stringToSoapDatapub.soap.utils:validateSoapData

pub.soap.ut i ls:str ingToSoapDataWmPublic. Converts a String containing a SOAP message to a SOAP object.

(A SOAP message must be represented as a SOAP object to be used with the data-retrieval services such as pub.soap.utils:getHeader and pub.soap.utils:getBody).

Note: This service is a convenient way to produce a SOAP object during development and testing. It is not meant to be used for production purposes because it does not ensure that a valid SOAP message is produced. Additionally, producing a SOAP object from a String is a very time-consuming process. For production purposes, we recommend that you create SOAP objects with the such as pub.soap.utils:getHeader and pub.soap.utils:getBody).

Input Parameters

Output Parameters

Usage Notes

Be aware that if string does not contain a valid SOAP message, this service does not throw an exception. Instead, it produces a soapData that contains a representation of whatever it received in string (which might not even be an XML document). This will cause problems later when you attempt to use the soapData with other SOAP utilities or pass it to the message handler. To determine whether soapData represents a valid SOAP message, we recommend that you always execute the pub.soap.utils:validateSoapData service immediately after using stringToSoapData.

See Also

pub.soap.utils:streamToSoapDatapub.soap.utils:validateSoapData

string String SOAP message that is to be converted to a SOAP object.

soapData Object SOAP object representation of the SOAP message in string.


pub.soap.utils:validateSoapData

pub.soap.ut i ls:val idateSoapDataWmPublic. Verifies that a SOAP object represents a valid SOAP message.

You can use this service to validate a SOAP object that was generated directly from an InputStream or String with pub.soap.utils:stringToSoapData or pub.soap.utils:streamToSoapData. If soapData does not contain a valid SOAP message, validateSoapData will throw an exception.

This service validates the SOAP object against the schema in pub.soap.schema:envelope.

Input Parameters

Output Parameters

None.

Usage Notes

If you create SOAP objects using the standard message-composition services (for example, pub.soap.utils:createSoapData, pub.soap.utils:addBodyEntry, pub.soap.utils:addHeaderEntry) there is no need to use this service. This service is only necessary when you generate a SOAP object directly from an InputStream or a String.

See Also

pub.soap.utils:stringToSoapDatapub.soap.utils:streamToSoapData

soapData Object SOAP object that you want to validate.


C H A P T E R28
Storage Folder
You use the elements in the storage folder to create, close, delete, and register repository data stores and insert and retrieve information from repository data stores. Each entry in a data store consists of a key (which identifies the entry) and a value.

When a flow service retrieves an entry from a data store, the entry is locked to prevent modification by other users. The entry, which needs to be unlocked before the flow completes, remains locked until released via a put (pub.storage:put) or an explicit unlock (pub.storage:unlock).

Note: If you include storage services in a flow and you want to test the flow from Developer, use Run or Run in Browser. Trace and Step cannot be used to test storage services.


C H A P T E R 2 8 S t o r a g e F o l d e r


pub.storage:addWmPublic. Inserts a new entry into a repository data store.

If the key already exists in the data store, the pub.storage:add service does nothing.

Input Parameters


pub.storage:add WmPublic. Inserts a new entry into a repository data store.

pub.storage:closeStore WmPublic. Closes a repository data store and unregisters the data store with the server.

pub.storage:deleteStore WmPublic. Deletes a repository data store and unregisters the data store with the server.

pub.storage:get WmPublic. Retrieves a value from a repository data store and locks the entry on behalf of the flow that invoked the service.

pub.storage:keys WmPublic. Obtains a list of all the keys in a repository data store.

pub.storage:lock WmPublic. Locks an entry on behalf of the flow invoking this service.

pub.storage:put WmPublic. Inserts or updates an entry in a repository data store. If the key does not exist in the data store, then the entry is inserted.

pub.storage:registerStore WmPublic. Opens or creates a repository data store and registers the store with the server.

pub.storage:remove WmPublic. Removes an entry from a repository data store.

pub.storage:unlock WmPublic. Unlocks an entry in the repository data store.

storeName String Name of the data store in which to insert the entry.

key String Key under which the entry is to be inserted.

value Document Value (IData object) to be inserted.


pub.storage:closeStore

Output Parameters

pub.storage:closeStoreWmPublic. Closes a repository data store and unregisters the data store with the server.

If the data store is not registered with the server, an exception will be thrown. A data store cannot be accessed after it has been unregistered. If you want to access the data in the data store, you need to register the data store again using pub.storage:registerStore.

Input Parameters

Output Parameters

None.

Usage Notes

This service does not delete the contents of the data store. If you want to delete the contents of a data store in addition to closing and unregistering the data store, use the pub.storage:deleteStore service.

pub.storage:deleteStoreWmPublic. Deletes a repository data store and unregisters the data store with the server.

Any data in the data store is deleted. If the data store is not registered with the server, an exception will be thrown.

Input Parameters

Output Parameters

None.

result String Flag indicating whether the entry was successfully added.


true The new entry was inserted successfully.

false The entry was not inserted (usually because an entry for key already exists).

storeName String Name of the data store to close and unregister.

storeName String Name of the data store to delete and unregister.



Usage Notes

If you want to close and unregister a data store without deleting the contents of the data store, use the pub.storage:closeStore service.

pub.storage:getWmPublic. Retrieves a value from a repository data store and locks the entry on behalf of the flow that invoked the service.

Locking the entry prevents other services from modifying the entry before the initial flow completes.

Important! The lock needs to be released, via a put (pub.storage:put) or an explicit unlock (pub.storage:unlock), before the flow completes.

Input Parameters

Output Parameters

storeName String Name of the data store from which you want to retrieve the entry.

key String Key of the entry whose value you want to retrieve.

waitLength String Optional. Length of time, in milliseconds, that you want to wait for this entry to become available if it is already locked by another thread. The default is the default Maximum Lock Wait value configured on the repository server (4 minutes).

lockMode String Optional. Type of lock you want to place on the entry.

Set to... To...

Exclusive Default. Prevent other threads from reading or updating the entry while you are using it. This type of lock allows you to modify the entry.

Share Prevent other threads from updating the entry while you are using it. This type of lock allows you to modify the entry.

Read Allow other threads to read and update the entry while you are using it. This type of lock allows you to read, but not modify, an entry.

value Document Retrieved entry (IData object). If the requested entry does not exist, the value of this parameter is null.


pub.storage:keys

pub.storage:keysWmPublic. Obtains a list of all the keys in a repository data store.

Input Parameters

Output Parameters

pub.storage: lockWmPublic. Locks an entry on behalf of the flow invoking this service.

Locking an entry prevents other services from modifying it before your flow completes.

Important! When you lock an entry using this service, the lock must be released, using a put (pub.storage:put) or an explicit unlock (pub.storage:unlock), before the flow completes.

Input Parameters

storeName String Name of the data store from which you want to obtain a list of keys.

keys String List Keys for the data store specified in storeName.

storeName String Name of the data store containing the entry.

key String Optional. Key of the entry that you want to lock. If key is not supplied, the lock will be applied to the entire data store specified in storeName.

waitLength String Optional. Length of time, in milliseconds, that you want to wait for this entry to become available if it is already locked by another thread. The default is the default Maximum Lock Wait value configured on the repository server (4 minutes).

lockMode String Optional. Type of lock you want to place on the entry.

Set to... To...

Exclusive Default. Prevent other threads from reading or updating the entry while you are using it. This type of lock allows you to modify the entry.

Share Prevent other threads from updating the entry while you are using it. This type of lock allows you to modify the entry.

Read Allow other threads to read and update the entry while you are using it. This type of lock allows you to read, but not modify, an entry.



Output Parameters

None.

pub.storage:putWmPublic. Inserts or updates an entry in a repository data store. If the key does not exist in the data store, then the entry is inserted.

If the key already exists in the store, then its value is updated and the associated entry is unlocked.

If the requested entry is not currently locked by the flow that invoked this service, the pub.storage:put service will automatically attempt to lock the entry.

Input Parameters

Output Parameters

None.

pub.storage:registerStoreWmPublic. Opens or creates a repository data store and registers the store with the server.

A data store must be registered before it can be accessed. If the store is already registered with the server, this service does nothing.

Input Parameters

Output Parameters

None.

storeName String Name of the data store into which you want to insert or update the entry.

value Document Value (IData object) to be inserted or updated.

waitLength String Optional. Length of time, in milliseconds, that you want to wait for this entry to become available if it is already locked by another thread. The default is the default Maximum Lock Wait value configured on the repository server (4 minutes). This parameter is used only when your service did not explicitly lock the entry beforehand.

key String Key where you want to insert or update the entry.

storeName String Name of the data store to register.


pub.storage:remove

Usage Notes

To unregister and close a store, use the service pub.storage:closeStore.

pub.storage:removeWmPublic. Removes an entry from a repository data store.

Input Parameters

Output Parameters

pub.storage:unlockWmPublic. Unlocks an entry in the repository data store.

When a flow retrieves an entry using the pub.storage:get service, the entry is locked to prevent modification by other users before the flow completes. The entry remains locked until the lock owner invokes a pub.storage:put service. To unlock a service without using the pub.storage:put service, use the pub.storage:unlock service.

Input Parameters

Output Parameters

None.

storeName String Name of the data store from which to remove an entry.

key String Key of the entry that you want to remove.

result String Flag indicating whether the entry was successfully removed.


true The entry was removed successfully.

false The entry was not removed (usually because an entry for key does not exist).

storeName String Name of the data store in which to unlock an entry.

key String Optional. Key of the entry that you want to unlock. If key is not supplied, the lock will be removed from the entire data store specified in storeName.


C H A P T E R29
Str ing Folder
You use the elements in the string folder to perform string manipulation and substitution operations.


C H A P T E R 2 9 S t r i n g F o l d e r



pub.string:base64Decode WmPublic. Decodes a Base-64 encoded string into a sequence of bytes.

pub.string:base64Encode WmPublic. Converts a sequence of bytes into a Base64-encoded String.

pub.string:bytesToString WmPublic. Converts a sequence of bytes to a String.

pub.string:concat WmPublic. Concatenates two strings.

pub.string:HTMLDecode WmPublic. Replaces HTML character entities with native characters.

pub.string:HTMLEncode WmPublic. Replaces HTML-sensitive characters with equivalent HTML character entities.

pub.string:indexOf WmPublic. Returns the index of the first occurrence of a sequence of characters in a string.

pub.string:length WmPublic. Returns the length of a string.

pub.string:lookupDictionary WmPublic. Looks up a given key in a hash table and returns the string to which that key is mapped.

pub.string:lookupTable WmPublic. Locates a key in a String Table and returns the string to which that key is mapped.

pub.string:makeString WmPublic. Builds a single string by concatenating the elements of a String List.

pub.string:messageFormat WmPublic. Formats an array of strings into a given message pattern.

pub.string:numericFormat WmPublic. Formats a number into a given numeric pattern.

pub.string:padLeft WmPublic. Pads a string to a specified length by adding pad characters to the beginning of the string.

Usage Notes WmPublic. Pads a string to a specified length by adding pad characters to the end of the string.

Usage Notes WmPublic. Replaces all occurrences of a specified substring with a substitute string.

pub.string:stringToBytes WmPublic. Converts a string to a byte array.

pub.string:substring WmPublic. Returns a substring of a given string.

pub.string:toLower WmPublic. Converts all characters in a given string to lowercase.

pub.string:toUpper WmPublic. Converts all characters in a given string to uppercase.

pub.string:tokenize WmPublic. Tokenizes a string using specified delimiter characters and generates a String List from the resulting tokens.


pub.string:base64Decode

pub.str ing:base64DecodeWmPublic. Decodes a Base-64 encoded string into a sequence of bytes.

Input Parameters

Output Parameters

pub.str ing:base64EncodeWmPublic. Converts a sequence of bytes into a Base64-encoded String.

Input Parameters

Output Parameters

pub.str ing:bytesToStr ingWmPublic. Converts a sequence of bytes to a String.

Input Parameters

pub.string:trim WmPublic. Trims leading and trailing white space from a given string.

pub.string:URLDecode WmPublic. Decodes a URL-encoded string.

pub.string:URLEncode WmPublic. URL-encodes a string.


string String A Base64-encoded String to decode into bytes.

value byte[ ] The sequence of bytes decoded from the Base64-encoded String.

bytes byte[ ] Sequence of bytes to encode into a Base64-encoded String.

value String Base64-encoded String encoded from the sequence of bytes.

bytes byte[ ] Sequence of bytes to convert to a String.

encoding String Optional. Name of a registered, IANA character set (for example, ISO-8859-1). If you specify an unsupported encoding, the system throws an exception.

To use the default encoding, set encoding to autoDetect.



Output Parameters

pub.str ing:concatWmPublic. Concatenates two strings.

Input Parameters

Output Parameters

pub.str ing:HTMLDecodeWmPublic. Replaces HTML character entities with native characters.

Specifically, the service:

Input Parameters

Output Parameters

string String String representation of the contents of bytes.

inString1 String String to which you want to concatenate another string.

inString2 String String to concatenate to inString1.

value String Result of concatenating inString1 with inString2 (inString1 + inString2).

Replaces this HTML character entity... With...

> >

< <

& &

" "

inString String An HTML-encoded String.

value String Result from decoding the contents of inString. Any HTML character entities that existed in inString will appear as native characters in value.


pub.string:HTMLEncode

pub.str ing:HTMLEncodeWmPublic. Replaces HTML-sensitive characters with equivalent HTML character entities.

Specifically, this service:

These translations are useful when displaying text in an HTML context.

Input Parameters

Output Parameters

pub.str ing: indexOfWmPublic. Returns the index of the first occurrence of a sequence of characters in a string.

Input Parameters

Output Parameters

Replaces this native language character... With...

> >

< <

& &

" "

inString String The character you want to encode in HTML.

value String Result from encoding the contents of inString. Any HTML-sensitive characters that existed in inString (for example, > or &) will appear as the equivalent HTML character entities in value.

inString String String in which you want to locate a sequence of characters.

subString String Sequence of characters to locate.

fromIndex String Optional. Index of inString from which to start the search. If no value is specified, this parameter contains 0 to indicate the beginning of the string.

value String Index of the first occurrence of subString in inString. If no occurrence is found, this parameter contains -1.



pub.str ing: lengthWmPublic. Returns the length of a string.

Input Parameters

Output Parameters

pub.str ing: lookupDict ionaryWmPublic. Looks up a given key in a hash table and returns the string to which that key is mapped.

Input Parameters

Output Parameters

pub.str ing: lookupTableWmPublic. Locates a key in a String Table and returns the string to which that key is mapped.

Input Parameters

inString String String whose length you want to discover.

value String The number of characters in inString.

hashtable java.util.Hashtable Hash table that uses String objects for keys and values.

key String Key in hashtable whose value you want to retrieve.

Note: The key is case sensitive.

value String Value of the string to which key is mapped. If the requested key in hashtable is null or if key is not mapped to any value in hashtable, the service returns null.

lookupTable String [ ] [ ] A multi-row, multi-column string table in which to search.

keyColumnIndex String Index of the “key” column. Default is 0.

valueColumnIndex String Index of the “value” column. Default is 1.

key String Key to locate.

Note: The key is case sensitive.

ignoreCase String Optional. Flag indicating whether to perform a case-sensitive or case-insensitive search.


pub.string:makeString

Output Parameters

pub.str ing:makeStr ingWmPublic. Builds a single string by concatenating the elements of a String List.

Input Parameters

Output Parameters

Set to... To...

true Perform a case-insensitive search.

false Default. Perform a case-sensitive search.

useRegex String Optional. Flag indicating whether the values in the table are to be interpreted as regular expressions.

Note: The regular expressions in the table should not include slashes. For example, use hello.*, not /hello.*/.

Set to... To...

true Interpret the key column values in the table as regular expressions.

false Default. Interpret the key column values in the table as literal values (that is, not regular expressions).

value String First value in the “value” column whose key matches key. If no match is found, this parameter is null.

elementList String List Strings to concatenate.

separator String String to insert between each non-null element in elementList.

value String Result from concatenating the strings in elementList. Strings are separated by the characters specified in separator.



pub.str ing:messageFormatWmPublic. Formats an array of strings into a given message pattern.

Input Parameters

Output Parameters

pub.str ing:numericFormatWmPublic. Formats a number into a given numeric pattern.

Input Parameters

pattern String Message that includes “placeholders” where elements from argumentList are to be inserted. The message can contain any sequence of characters. Use the {n} placeholder to insert elements from argumentList, where n is the index of the element that you want to insert. For example, the following pattern string inserts elements 0 and 1 into the message:

Test results: {0} items passed, {1} items failed.

Note: Do not use any characters except digits for n.

argumentList String List Optional. List of strings to use to populate pattern. If argumentList is not supplied, the service will not replace placeholders in pattern with actual values.

value String Result from substituting argumentList into pattern. If pattern is empty or null, this parameter is null.

num String The number to format.

pattern String A pattern string that describes the way in which num is to be formatted:

This symbol... Indicates...

0 A digit.

# A digit. Leading zeroes will not be shown.

. A placeholder for a decimal separator.

, A placeholder for a grouping separator.

; A separation in format.

- The default negative prefix.

% That num will be multiplied by 100 and shown as a percentage.

X Any character used as a prefix or suffix (for example, A, $).


pub.string:padLeft

Output Parameters

pub.str ing:padLeftWmPublic. Pads a string to a specified length by adding pad characters to the beginning of the string.

Input Parameters

Output Parameters

Usage Notes

If padString is longer than one character and does not fit exactly into the resulting string, the beginning of padString is aligned with the beginning of the resulting string. For example, suppose inString equals shipped and padString equals x9y.

' That special characters are to be used as literals in a prefix or suffix. Enclose the special characters within '' (for example, '#').

The following are examples of pattern strings:

Pattern Description

#,### Use commas to separate into groups of three digits.

#,#### Use commas to separate into groups of four digits.

$#.00 Show digits before the decimal point as needed and exactly two digits after the decimal point. Prefix with the $ character.

'#'#.0 Show digits before the decimal point as needed and exactly one digit after the decimal point. Prefix with the # character.

value String num formatted according to pattern. If pattern is an empty (not null) string, the default pattern of comma separators and three decimal places is used. For example, 1121.888888 would be returned as 1,121.888.

inString String String that you want to pad.

padString String Characters to use to pad inString.

length String Total length of the resulting string, including pad characters.

value String Contents of inString preceded by as many pad characters as needed so that the total length of the string equals length.



If inString is longer than length characters, only the last length characters from inString are returned. For example, if inString equals acct1234 and length equals 4, value will contain 1234.

pub.str ing:padRightWmPublic. Pads a string to a specified length by adding pad characters to the end of the string.

Input Parameters

Output Parameters

Usage Notes

If padString is longer than one character and does not fit exactly into the resulting string, the end of padString is aligned with the end of the resulting string. For example, suppose inString equals shipped and padString equals x9y.

If inString is longer than length characters, only the first length characters from inString are returned. For example, if inString equals 1234acct and length equals 4, value will contain 1234.

If length equals... Then value will contain...

7 shipped

10 x9yshipped

12 x9x9yshipped

inString String String that you want to pad.

padString String Characters to use to pad inString.

length String Total length of the resulting string, including pad characters.

value String Contents of inString followed by as many pad characters as needed so that the total length of the string equals length.

If length equals... Then value will contain...

7 shipped

10 shippedx9y

12 shippedx9y9y


pub.string:replace

pub.str ing:replaceWmPublic. Replaces all occurrences of a specified substring with a substitute string.

Input Parameters

Output Parameters

pub.str ing:str ingToBytesWmPublic. Converts a string to a byte array.

Input Parameters

Output Parameters

inString String String containing the substring to replace.

searchString String Substring to replace within inString.

replaceString String Character sequence that will replace searchString. If this parameter is null or empty, the service removes all occurrences of searchString from inString.

useRegex String Optional. Flag indicating whether searchString is a regular expression. When regular expressions are used to specify a search string, replaceString may also contain interpolation variables (for example, “$1”) that match parenthetical subexpressions in searchString.

Set to... To...

true Indicate that searchString is a regular expression.

false Default. Indicate that searchString is not a regular expression.

value String Contents of inString with replacements made.

string String String to convert to a byte[ ].

encoding String Optional. Name of a registered, IANA character set that specifies the encoding to use when converting the String to an array of bytes (for example: ISO-8859-1).

To use the default encoding, set this value to autoDetect. If you specify an unsupported encoding, an exception will be thrown.

bytes byte[ ] Contents of string represented as a byte[ ].



pub.str ing:substr ingWmPublic. Returns a substring of a given string.

Input Parameters

Output Parameters

pub.str ing:toLowerWmPublic. Converts all characters in a given string to lowercase.

Input Parameters

Output Parameters

pub.str ing:toUpperWmPublic. Converts all characters in a given string to uppercase.

Input Parameters

inString String String from which to extract a substring.

beginIndex String Beginning index of the substring to extract (inclusive).

endIndex String Ending index of the substring to extract (exclusive). If this parameter is null or empty, the substring will extend to the end of inString.

value String Substring from beginIndex and extending to the character at endIndex - 1.

inString String String to convert.

language String Optional. Lowercase, two-letter ISO-639 code. If this parameter is null, the system default is used.

country String Optional. Uppercase, two-letter ISO-3166 code. If this parameter is null, the system default is used.

variant String Optional. Vendor and browser-specific code. If null, this parameter is ignored.

value String Contents of inString, with all uppercase characters converted to lowercase.

inString String String to convert.


pub.string:tokenize

Output Parameters

pub.str ing:tokenizeWmPublic. Tokenizes a string using specified delimiter characters and generates a String List from the resulting tokens.

This service does not return delimiters as tokens.

Input Parameters

Output Parameters

pub.str ing:tr imWmPublic. Trims leading and trailing white space from a given string.

Input Parameters

Output Parameters

language String Optional. Lowercase, two-letter ISO-639 code. If this parameter is null, the system default is used.

country String Optional. Uppercase, two-letter ISO-3166 code. If this parameter is null, the system default is used.

variant String Optional. Vendor and browser-specific code. If null, this parameter is ignored.

value String Contents of inString, with all lowercase characters converted to uppercase.

inString String String you want to tokenize (that is, break into delimited chunks).

delim String Delimiter characters. If null or empty, the service uses the default delimiters \t\n\r, where t, n, and r represent the white space characters tab, new line, and carriage return).

valueList String List Strings containing the tokens extracted from inString.

inString String String to trim.

value String Contents of inString with white space trimmed from both ends.



pub.str ing:URLDecodeWmPublic. Decodes a URL-encoded string.

Input Parameters

Output Parameters

pub.str ing:URLEncodeWmPublic. URL-encodes a string.

Encodes characters the same way that data posted from a WWW form is encoded (that is, the application/x-www-form-urlencoded MIME type).

Input Parameters

Output Parameters

inString String URL-encoded string to decode.

value String Result from decoding inString. If inString contained plus (+) signs, they will appear in value as spaces. If inString contained %hex encoded characters, they will appear in value as the appropriate native character.

inString String String to URL-encode.

value String Result from URL-encoding inString. If inString contained non-alphanumeric characters (except [-_.*@]), they will appear in value as their URL-encoded equivalents (% followed by a two-digit hex code). If inString contained spaces, they will appear in value as plus (+) signs.


C H A P T E R30
Sync Folder
You use the elements in the sync folder to coordinate the execution of services. You can coordinate services so that a waiting service will execute if and only if a notifying service produces the input required by the waiting service within a specified time period. The synchronization services wait for and send notification using a key. A notifying service only delivers input to waiting services with the same key.


C H A P T E R 3 0 S y n c F o l d e r


pub.sync:not i fyWmPublic. Notifies services waiting on the specified key and delivers the input document to the services.

Receives a count of the number of notified services.

Input Parameters

Output Parameters

pub.sync:waitWmPublic. Allows one or more services to wait for delivery of data from a notifying service.

Notification must occur within a specified time period.

Input Parameters


pub.sync:notify WmPublic. Notifies services waiting on the specified key and delivers the input document to the services.

pub.sync:wait WmPublic. Allows one or more services to wait for delivery of data from a notifying service.

key String Name of the key. Waiting services with the same key will receive notification and input from this service.

value Document Input for the waiting services.

notified String Number indicating how many services were notified.

key String Name of the key for which the service is waiting notification. The service receives notification and data from a notifying service with the same key.

time String Length of time, in seconds, the service waits for notification. If the request times out, an exception is thrown.

exclusive String Optional. Flag indicating whether other services can wait for notification from a notifying service with the specified key.


pub.sync:wait

Output Parameters

Set to... To...

yes Allow only one service to wait for notification.

no Default. Allow other services to wait for notification.

value Document Input delivered by the notifying service.


C H A P T E R 3 0 S y n c F o l d e r


C H A P T E R31
Synchronizat ion Folder
You use the elements in the synchronization folder to perform latching and cross-referencing operations in a publish-and-subscribe integration.


C H A P T E R 3 1 S y n c h r o n i z a t i o n F o l d e r


pub.synchronizat ion. latch:closeLatchWmPublic. Closes the latch for a resource.

The resource cannot be acted upon while the latch is closed. By closing a latch, you can prevent a circular update between the source and target resources.

Input Parameters


pub.synchronization.latch:closeLatch WmPublic. Closes the latch for a resource.

pub.synchronization.latch:isLatchClosed WmPublic. Checks a resource’s latch status.

pub.synchronization.latch:openLatch WmPublic. Opens the latch for a resource.

pub.synchronization.xref:createXReference WmPublic. Creates a cross-reference between a canonical key and a native ID.

pub.synchronization.xref:deleteByObjectId WmPublic. Removes all cross-reference records associated with a particular process or synchronization.

pub.synchronization.xref:deleteXReference WmPublic. Deletes a cross-reference record from the cross-reference table.

pub.synchronization.xref:getCanonicalKey WmPublic. Retrieves the canonical key for a specified native ID.

pub.synchronization.xref:getNativeId WmPublic. Retrieves the native ID of a resource record associated with a canonical key.

pub.synchronization.xref:insertXReference WmPublic. Inserts a cross-reference between a native ID and a canonical key.

appId String A unique identifier for the target resource for which you want to close a latch. Typically, the appId is the name of the adapter or the resource.

canonicalKey String The canonical key. A unique identifier for the canonical document used in the synchronization.

objectId String A unique identifier for the object or process being synchronized. Typically, the objectId field is set to the name of the business process for which you are performing synchronization, such as “order” or “customer.”


pub.synchronization.latch:isLatchClosed

Output Parameters

None.

pub.synchronizat ion. latch: isLatchClosedWmPublic. Checks a resource’s latch status.

By checking the latch status, you can determine whether a resource has been updated.

Input Parameters

Output Parameters

Usage Notes

Use the latch status to determine whether or not to update the resource.

If the latch is closed (isLatchClosed is true), the resource is already updated. Use the pub.synchronization.latch:openLatch service to end execution of the update and open the latch in preparation for the next update to the resource.

If the latch is open (isLatchClosed is false), the resource has not yet been updated. Invoke services to locate and update the record in the target resource. Then invoke the pub.synchronization.latch:closeLatch service to close the latch and prevent circular updates.

For more information about using the pub.synchronization.latch services to prevent echo suppression, see the Publish-Subscribe Developer’s Guide.

See Also

pub.synchronization.latch:closeLatchpub.synchronization.latch:openLatch

appId String A unique identifier for the resource for which you want to check the latch status. Typically, the appId is the name of the adapter or the resource.



isLatchClosed String The status of the latch.


true The latch is closed. The resource has been updated.

false The latch is open. The resource has not been updated.



pub.synchronizat ion. latch:openLatchWmPublic. Opens the latch for a resource.

By opening the latch, you can end propagation of the update and make the resource available for future updates.

Input Parameters

Output Parameters

None.

pub.synchronizat ion.xref:createXReferenceWmPublic. Creates a cross-reference between a canonical key and a native ID.

Input Parameters

Output Parameters

appId String A unique identifier for the resources for which you want to open the latch. Typically, the appId is the name of the adapter or the resource.



appId String A unique identifier for the resource (application) for which you want to create a cross-reference to a canonical key.

nativeId String A unique identifier for the resource record for which you want to create a cross-reference to a canonical key.

canonicalKey String Optional. A canonical key. If a canonical key is not provided as input, createXReference creates the canonical key and the cross-reference.


canonicalKey String The canonical key. This key correlates native IDs of records from different resources. This will be a new, unique key if canonicalKey was not provided as an input parameter. If canonicalKey was provided as input, this output parameter returns the same value.


pub.synchronization.xref:deleteByObjectId

Usage Notes

The canonical document is the standard format that a document assumes while it travels through the webMethods Integration Platform. A source resource will convert or map data from its proprietary data format into the canonical format before publishing the document. A target resource (a subscriber to the canonical document) will map the canonical document to the target resource’s proprietary data format before processing the document. The canonical document acts as the intermediary data format between resources.

On the source side of the synchronization, use the createXReference service to create the canonical key for the canonical document and establish a cross-reference between the record in the source application and the canonical document. Before publishing the canonical document, link the generated canonicalKey to the canonical document.

On the target side of synchronization, use the pub.synchronization.xref:insertXReference service to insert the cross-reference between a canonical key and the native ID for the record in the target resource.

For more information about using the createXReference service to create synchronizations, see the Publish-Subscribe Developer’s Guide.

See Also

pub.synchronization.xref:insertXReference

pub.synchronizat ion.xref:deleteByObject IdWmPublic. Removes all cross-reference records associated with a particular process or synchronization.

Input Parameters

Output Parameters

None.

Usage Notes

You can use this service to purge unwanted cross-reference records from the cross-reference table. For example, if you wanted to delete all cross-reference records for the purchaseOrder synchronization, specify “purchaseOrder” as the objectId.

objectId String A unique identifier for the object or process for which you want to delete all cross-reference records. Typically, the objectId field is set to the name of the business process for which you are performing synchronization, such as “order” or “customer.”



pub.synchronizat ion.xref:deleteXReferenceWmPublic. Deletes a cross-reference record from the cross-reference table.

This service deletes only one cross-reference record.

Input Parameters

Output Parameters

None.

pub.synchronizat ion.xref:getCanonicalKeyWmPublic. Retrieves the canonical key for a specified native ID.

Input Parameters

Output Parameters

Usage Notes

You can use this service to determine whether you need to insert or update a record in the resource.

If the canonical key exists (canonicalKey contains a value), a cross-reference between the native ID and the canonical key already exists. The record with the specified nativeId is not a new record.

appId String A unique identifier for the resource (application) for which you want to delete a cross-reference record.

canonicalKey String The canonical key. A unique identifier for the canonical document for which you want to delete a cross-reference.

objectId String A unique identifier for the object or process for which you want to delete a cross-reference. Typically, the objectId field is set to the name of the business process for which you are performing synchronization, such as “order” or “customer.”

appId String A unique identifier for the resource (application) that contains the native ID for which you want to retrieve a canonical key.

nativeId String A unique identifier for the resource record for which you want to obtain the canonical key.


canonicalKey String The canonical key for the provided native ID. If the requested key cannot be found or does not exist in the cross-reference table, an empty string is returned.


pub.synchronization.xref:getNativeId

You can then invoke the pub.synchronization.latch:isLatchClosed service to determine whether the resource needs to be updated.

If the canonical key does not exist (canonicalKey contains an empty string), then the record with the native ID is a new record. You can use the pub.synchronization.xref:createXReference service to generate the canonical key and create the cross-reference to the native ID.

For more information about using the getCanonicalKey service in synchronizations, see the Publish-Subscribe Developer’s Guide.

See Also

pub.synchronization.latch:isLatchClosedpub.synchronization.xref:createXReference

pub.synchronizat ion.xref:getNat iveIdWmPublic. Retrieves the native ID of a resource record associated with a canonical key.

Input Parameters

Output Parameters

Usage Notes

You can use the getNativeID service on the target side of a synchronization to determine if the record in the target resource needs to be inserted or just updated.

If the native ID does not exist (the nativeId field contains an empty string) and you specified the correct input values, then the record does not exist in the resource. You will need to insert the record in the resource to generate the native ID. Then use the pub.synchronization.xref:insertXReference service to insert a cross-reference between the native ID and the canonical key.

If the native ID exists (the nativeId field contains a value), then a cross-reference between the canonical key and the record already exists. The record already exists in the resource and only needs to be updated.

appId String A unique identifier for the resource from which you want to retrieve the native ID associated with the provided canonical key.

canonicalKey String The canonical key for which you want to obtain the corresponding native ID.


nativeId String A unique identifier for the resource record associated with the provided canonical key. If the requested nativeId cannot be found in the cross-reference table, an empty string is returned.



After you insert or update the record in the resource, make sure to use pub.synchronization.latch:closeLatch to close the latch for the record to prevent circular updates (echoes).

For more information about using the getNativeId service in synchronizations, see the Publish-Subscribe Developer’s Guide.

See Also

pub.synchronization.latch:closeLatchpub.synchronization.xref:insertXReference

pub.synchronizat ion.xref: insertXReferenceWmPublic. Inserts a cross-reference between a native ID and a canonical key.

Input Parameters

Output Parameters

None.

Usage Notes

Use this service on the target side of a synchronization to create a cross-reference between the new record in the target resource and the canonical document.

Most resources generate a unique ID for a new record. Invoke the insertXReference service after you add the new record in the resource.

After you insert the cross-reference between the new native ID and the canonical key, use pub.synchronization.latch:closeLatch to close the latch for the record to prevent circular updates (echoes).

For more information about using the insertXReference service in synchronizations, see the Publish-Subscribe Developer’s Guide.

See Also

pub.synchronization.latch:closeLatchpub.synchronization.xref:createXReference

appId String A unique identifier for the resource for which you want to establish a cross-reference between a native ID and a canonical key.

nativeId String A unique identifier for the resource record with which you want to establish a cross-reference to canonicalKey.

canonicalKey String The canonical key with which you want to establish a cross-reference to nativeId.



C H A P T E R32
Table Folder
You use the elements in the table folder to convert instances of com.wm.util.Table to other data types.

Important! The services in this folder have been deprecated.


C H A P T E R 3 2 Ta b l e F o l d e r


pub.table:recordListToTableWmPublic. Deprecated—Converts a list of documents into an instance of com.wm.util.Table.

Input Parameters

Output Parameters

pub.table:str ingTableToTableWmPublic. Deprecated—Converts a String Table into an instance of com.wm.util.Table.

Input Parameters


pub.table:recordListToTable WmPublic. Deprecated—Converts a list of documents into an instance of com.wm.util.Table.

pub.table:stringTableToTable WmPublic. Deprecated—Converts a String Table into an instance of com.wm.util.Table.

pub.table:tableToRecordList WmPublic. Deprecated—Converts an instance of com.wm.util.Table into a document list.

pub.table:tableToStringTable WmPublic. Deprecated—Converts an instance of com.wm.util.Table into a two-dimensional String array.

recordList Document List Data for the new table. Each document represents a row for the new table.

columnNames String List Array of Strings representing the column names for the new table. Each document will be queried for a value for each column.

tableName String Optional. Name for the new table.

table com.wm.util.Table The resulting table with the supplied data.

columnNames String List Column names for the new table.

stringTable String Table Data for the new table.

tableName String Optional. Name for the new table.


pub.table:tableToRecordList

Output Parameters

Usage Notes

For example, to create a two-column table which maps ID numbers to names, you might use the following parameters:

columnNames = id, name

stringTable = (1099, Arthur), (3000, Dorothy), (2068, scott)

tableName = idTable

pub.table:tableToRecordListWmPublic. Deprecated—Converts an instance of com.wm.util.Table into a document list.

Note: In versions 3.5 and later, there is no need to use this service to convert a table to a document list in order to map it in a flow service. Objects in the pipeline that are of type com.wm.util.Table are automatically recognized and treated as document lists at run time.

Input Parameters

Output Parameters

pub.table:tableToStr ingTableWmPublic. Deprecated—Converts an instance of com.wm.util.Table into a two-dimensional String array.

Input Parameters

Output Parameters

table com.wm.util.Table The resulting table with the supplied data.

table com.wm.util.Table Table to convert to a document list.

recordList Document List Data from the table. Each document represents a row from the table. The keys of the document are the column names and their values are the corresponding values in that row.

table com.wm.util.Table Table to convert to a String table.

columnNames String List Column names from the table.

stringTable String Table Data from the table.


C H A P T E R 3 2 Ta b l e F o l d e r


C H A P T E R33
UDDI Folder
The UDDI folder provides services, specifications, and document types for UDDI inquiry and publishing. You can use these elements to:

query about Web service information

publish an existing Integration Server service as a Web service to a UDDI server.

The UDDI services, specifications, and document types are compliant with UDDI Version 2.04. For more information, see:

UDDI Version 2.04 Specification

UDDI Version 2.03 Data Structure Reference


http://uddi.org/pubs/ProgrammersAPI-V2.04-Published-20020719.htm

http://uddi.org/pubs/DataStructure-V2.03-Published-20020719.htm

C H A P T E R 3 3 U D D I F o l d e r



pub.uddi.client.doc:accessPoint WmUDDI. Document type that conveys the entry point address suitable for calling a particular Web service. The accessPoint document type is an attribute-qualified pointer to a service entry point.

pub.uddi.client.doc:address WmUDDI. Document type that is a simple list of pub.uddi.client.doc:addressLine elements within the address container.

pub.uddi.client.doc:addressLine WmUDDI. Document type that contains the address line information.

pub.uddi.client.doc:assertionStatusItem WmUDDI. Document type that contains the assertion status information.

pub.uddi.client.doc:assertionStatusReport WmUDDI. Document type that reports all complete and incomplete assertions and serves an administrative use, including determining if there are any outstanding, incomplete assertions about relationships involving businesses with which the publisher account is associated.

pub.uddi.client.doc:authToken WmUDDI. Document type that contains a single authInfo element that contains an access token that is to be passed back in all Publisher’s API messages that change data.

pub.uddi.client.doc:bindingDetail WmUDDI. Document type that consists of one or more bindingTemplate structures that are returned according to the data requested in the request message.

pub.uddi.client.doc:bindingKey WmUDDI. Document type that contains a unique key for a given bindingTemplate.

pub.uddi.client.doc:bindingTemplate WmUDDI. Document type that holds technical service description information related to a given business service family.

pub.uddi.client.doc:bindingTemplates WmUDDI. Document type that contains list of bindingTemplates.

pub.uddi.client.doc:businessDetail WmUDDI. Document type that consists of one or more businessDetail structures that are returned according to the data requested in the request message.

pub.uddi.client.doc:businessDetailExt WmUDDI. Document type that consists of one or more businessDetailExt structures that are returned according to the data requested in the request message.


pub.uddi.client.doc:businessEntity WmUDDI. Document type that represents all known information about a business or entity that publishes descriptive information about the entity as well as the services that it offers.

pub.uddi.client.doc:businessEntityExt WmUDDI. Document type that that contains a pub.uddi.client.doc:businessEntity document.

pub.uddi.client.doc:businessInfo WmUDDI. Document type that contains company name and optional description data, along with a collection element named serviceInfos that in turn can contain one or more serviceInfo structures.

pub.uddi.client.doc:businessInfos WmUDDI. Document type that consists of list of businessInfo documents.

pub.uddi.client.doc:businessKey WmUDDI. Document type that contains the unique identifier for a given instance of a pub.uddi.client.doc:businessEntity structure.

pub.uddi.client.doc:businessList WmUDDI. Document type that contains zero or more businessInfos structures.

pub.uddi.client.doc:businessService WmUDDI. Document type that represents a logical service classification.

pub.uddi.client.doc:businessServices WmUDDI. Document type that lists the businessService documents.

pub.uddi.client.doc:categoryBag WmUDDI. Document type that allows pub.uddi.client.doc:businessEntity, businessService, and tModel structures to be categorized according to any of several available taxonomy based classification schemes.

pub.uddi.client.doc:contact WmUDDI. Document type that lets you record contact information for a person.

pub.uddi.client.doc:contacts WmUDDI. Document type that provides a way for information to be registered with a pub.uddi.client.doc:businessEntity record so that someone that finds the information can make human contact for any purpose.

pub.uddi.client.doc:discoveryURL WmUDDI. Document type that consists of an attribute whose value designates the URL use type convention, and a string, found within the body of the element.

pub.uddi.client.doc:discoveryURLs WmUDDI. Document type that is used to hold pointers to URL addressable discovery documents.




pub.uddi.client.doc:dispositionReport WmUDDI. Document type that is used to report status of various publish operations.

pub.uddi.client.doc:docType_categoryBag WmUDDI. Document type that allows pub.uddi.client.doc:businessEntity, businessService and tModel structures to be categorized according to any of several available taxonomy based classification schemes.

pub.uddi.client.doc:docType_description WmUDDI. Document type that contains the description with language resource information.

pub.uddi.client.doc:docType_keyedReference WmUDDI. Document type that designates the relationship type for which the assertion is made, represented by the included tModelKey and described by the included keyName keyValue pair.

pub.uddi.client.doc:docType_name WmUDDI. Document type that describes a name.

pub.uddi.client.doc:email WmUDDI. Document type that describes the e-mail information.

pub.uddi.client.doc:errInfo WmUDDI. Document type that describes the error information.

pub.uddi.client.doc:findQualifier WmUDDI. Document type that provides a means to allow the caller to override default search behaviors.

pub.uddi.client.doc:findQualifiers WmUDDI. Document type that contains a list of find qualifiers.

pub.uddi.client.doc:fromKey WmUDDI. Document type that contains a UUID reference to a business Entity.

pub.uddi.client.doc:hostingRedirector WmUDDI. Document type that is used to designate that a bindingTemplate entry is a pointer to a different bindingTemplate entry.

pub.uddi.client.doc:identifierBag WmUDDI. Document type that is a general-purpose placeholder for any number of distinct identifiers.

pub.uddi.client.doc:instanceDetails WmUDDI. Document type that holds service instance specific information that is required to either understand the service implementation details relative to a specific tModelKey reference, or to provide further parameter and settings support.

pub.uddi.client.doc:instanceParms WmUDDI. Document type that is used to contain settings parameters or a URL reference to a file that contains settings or parameters required to use a specific facet of a bindingTemplate description.



pub.uddi.client.doc:keyedReference WmUDDI. Document type that designates the relationship type for which the assertion is made, represented by the included tModelKey and described by the included keyName keyValue pair.

pub.uddi.client.doc:keysOwned WmUDDI. Document type that designates those business keys the publisher manages.

pub.uddi.client.doc:overviewDoc WmUDDI. Document type that is used to house references to remote descriptive information or instructions related to proper use of a bindingTemplate technical sub-element.

pub.uddi.client.doc:phone WmUDDI. Document type that is used to hold telephone numbers for the contact.

pub.uddi.client.doc:publisherAssertion WmUDDI. Document type that describes a publisher assertion structure.

pub.uddi.client.doc:publisherAssertions WmUDDI. Document type that returns all assertions made by the publisher who was authenticated in the preceding set_publisherAssertions or the get_publisherAssertions API calls.

pub.uddi.client.doc:registeredInfo WmUDDI. Document type that contains overview information that is suitable for identifying all pub.uddi.client.doc:businessEntity and tModel data published by the requester.

pub.uddi.client.doc:relatedBusinessInfo WmUDDI. Document type that contains information about a pub.uddi.client.doc:businessEntity that relates to the specified pub.uddi.client.doc:businessEntity by at least one relationship.

pub.uddi.client.doc:relatedBusinessInfos WmUDDI. Document type that contains information about a pub.uddi.client.doc:businessEntity that relates to the specified pub.uddi.client.doc:businessEntity by at least one relationship.

pub.uddi.client.doc:relatedBusinessesList WmUDDI. Document type that contains list of related business lists.

pub.uddi.client.doc:result WmUDDI. Document type that defines the result structure.

pub.uddi.client.doc:schema_uddiv2 WmUDDI. Schema created using the webMethods schema generator as part of creating document types. It is created from the XSD document specified by UDDI Version 2.0 UDDI XML Schema 2001.




pub.uddi.client.doc:serviceDetail WmUDDI. Schema created using the webMethods schema generator as part of creating document types. It is created from the XSD document specified by UDDI Version 2.0 UDDI XML Schema 2001.

pub.uddi.client.doc:serviceInfo WmUDDI. Document type that are abbreviated versions of businessService data, suitable for populating a list of services associated with a business and that match a pattern as specified in the inputs to the find_service API.

pub.uddi.client.doc:serviceInfos WmUDDI. Document type that consists of list of serviceInfo documents.

pub.uddi.client.doc:serviceKey WmUDDI. Document type that is a UUID key to identify a service.

pub.uddi.client.doc:serviceList WmUDDI. Document type that contains list of serviceInfo documents.

pub.uddi.client.doc:sharedRelationships WmUDDI. Document type that contains the keyed references and direction to it.

pub.uddi.client.doc:SOAPFault WmUDDI. Document type that contains the SOAP Fault structure.

pub.uddi.client.doc:tModel WmUDDI. Document type that takes the form of keyed metadata (data about data). In a general sense, the purpose of a tModel within the UDDI registry is to provide a reference system based on abstraction.

pub.uddi.client.doc:tModelBag WmUDDI. Document type that contains a list of tModelKeys.

pub.uddi.client.doc:tModelDetail WmUDDI. Document type that contains list of tModel documents.

pub.uddi.client.doc:tModelInfo WmUDDI. Document type that contains overview data about business and tModel information published by a given publisher.

pub.uddi.client.doc:tModelInfos WmUDDI. Document type that consists of list of tModelInfo documents.

pub.uddi.client.doc:tModelInstanceDetails WmUDDI. Document type that is a simple accessor container for one or more pub.uddi.client.doc:tModelInstanceInfo documents.

pub.uddi.client.doc:tModelInstanceInfo WmUDDI. Document type that is a tModelInstanceInfo structure representing the bindingTemplate instance specific details for a single tModel by reference.



pub.uddi.client.doc:tModelKey WmUDDI. Document type that contains a tModelKey UUID.

pub.uddi.client.doc:tModelList WmUDDI. Document type that contains zero or more tModelInfo structures in response to a find_tModel inquiry message.

pub.uddi.client.doc:toKey WmUDDI. Document type that contains the toKey UUID.

pub.uddi.client.doc:uploadRegister WmUDDI. Document type that contains the uploadRegister string.

pub.uddi.client.inquiry:find_binding WmUDDI. Locates specific bindings within a registered business service.

pub.uddi.client.inquiry:find_business WmUDDI. Locates one or more businesses. It then returns a businessList message that matches the conditions specified in the argument.

pub.uddi.client.inquiry:find_businessByCategory WmUDDI. Locates one or more businesses based on category references passed.

pub.uddi.client.inquiry:find_businessByDiscURLs WmUDDI. Locates one or more businesses based on discoveryURLs.

pub.uddi.client.inquiry:find_businessByIdentity WmUDDI. Locates one or more businesses based on business identifier references.

pub.uddi.client.inquiry:find_businessByName WmUDDI. Locates one or more businesses based on names.

pub.uddi.client.inquiry:find_businessBytModel WmUDDI. Locates one or more businesses based on tModel references.

pub.uddi.client.inquiry:find_relatedBusinesses WmUDDI. Locates information about pub.uddi.client.doc:businessEntity registrations that are related to the specific business entity whose key is passed in the inquiry.

pub.uddi.client.inquiry:find_service WmUDDI. Locates specific services within a registered pub.uddi.client.doc:businessEntity.

pub.uddi.client.inquiry:find_serviceByBusKey WmUDDI. Locates specific services within a registered pub.uddi.client.doc:businessEntity based on business key identifier.

pub.uddi.client.inquiry:find_serviceByCategory WmUDDI. Locates specific services within a registered pub.uddi.client.doc:businessEntity based on list of category key identifiers.




pub.uddi.client.inquiry:find_serviceByName WmUDDI. Locates specific services within a registered pub.uddi.client.doc:businessEntity based on list of service names.

pub.uddi.client.inquiry:find_serviceBytModel WmUDDI. Locates specific services within a registered pub.uddi.client.doc:businessEntity based on list of tModel references.

pub.uddi.client.inquiry:find_tModel WmUDDI. Locates one or more tModel information structures matching the set of specific criteria.

pub.uddi.client.inquiry:find_tModelByCategory WmUDDI. Locates one or more tModel information structures based on list of category references.

pub.uddi.client.inquiry:find_tModelByIdentity WmUDDI. Locates one or more tModel information structures based on list of business identity references.

pub.uddi.client.inquiry:find_tModelByName WmUDDI. Locates one or more tModel information structures based on list of business identity references.

pub.uddi.client.inquiry:get_bindingDetail WmUDDI. Retrieves full binding template information suitable for making one or more service requests.

pub.uddi.client.inquiry:get_businessDetail WmUDDI. Retrieves the full pub.uddi.client.doc:businessEntity information for one or more businesses or organizations.

pub.uddi.client.inquiry:get_businessDetailExt WmUDDI. Retrieves extended pub.uddi.client.doc:businessEntity information for one or more specified pub.uddi.client.doc:businessEntity registrations.

pub.uddi.client.inquiry:get_serviceDetail WmUDDI. Retrieves full details for a given set of registered businessService data.

pub.uddi.client.inquiry:get_tModelDetail WmUDDI. Retrieves full details for a given set of registered tModel data.

pub.uddi.client.publish:add_publisherAssertions WmUDDI. Adds relationship assertions to the existing set of assertions.

pub.uddi.client.publish:delete_binding WmUDDI. Deletes one or more instances of bindingTemplate data from the UDDI registry.

pub.uddi.client.publish:delete_business WmUDDI. Removes one or more business registrations (for example, registered pub.uddi.client.doc:businessEntity data) and all direct contents from a UDDI registry.

pub.uddi.client.publish:delete_publisherAssertions WmUDDI. Removes one or more publisherAssertion elements to be removed from a publisher’s assertion collection.



pub.uddi.client.publish:delete_service WmUDDI. Removes one or more previously businessService elements from the UDDI registry and from its containing pub.uddi.client.doc:businessEntity parent.

pub.uddi.client.publish:delete_tModel WmUDDI. Logically deletes one or more tModel structures. Logical deletion hides the deleted tModels from find_tModel result sets, but does not physically delete it.

pub.uddi.client.publish:discard_authToken WmUDDI. Informs an Operator Site that the authentication token is to be discarded, effectively ending the session.

pub.uddi.client.publish:get_assertionstatusReport WmUDDI. Provides administrative support for determining the status of current and outstanding publisher assertions that involve any of the business registrations managed by the individual publisher account.

pub.uddi.client.publish:get_authToken WmUDDI. Obtains an authentication token.

pub.uddi.client.publish:get_publisherAssertions WmUDDI. Obtains the full set of publisher assertions that is associated with an individual publisher account.

pub.uddi.client.publish:get_registeredInfo WmUDDI. Gets an abbreviated list of all pub.uddi.client.doc:businessEntity and tModel data that are controlled by the individual associated with the credentials passed.

pub.uddi.client.publish:save_binding WmUDDI. Saves or updates a complete bindingTemplate element.

pub.uddi.client.publish:save_business WmUDDI. Saves or updates information about a complete pub.uddi.client.doc:businessEntity element.

pub.uddi.client.publish:save_service WmUDDI. Adds or updates one or more businessService elements.

pub.uddi.client.publish:save_tModel WmUDDI. Adds or updates one or more registered tModel elements.

pub.uddi.client.publish:set_publisherAssertions WmUDDI. Manages all of the tracked relationship assertions associated with an individual publisher account.




pub.uddi .c l ient .doc:accessPointWmUDDI. Document type that conveys the entry point address suitable for calling a particular Web service. The accessPoint document type is an attribute-qualified pointer to a service entry point.

Parameters

See Also

pub.uddi.client.doc:tModelpub.uddi.client.doc:tModelInstanceInfo

Examples

See the following in the Samples folder in the WmUDDI package:

samples.uddi.client:create_bindingTemplate

*body String Optional. Body of the URL.

@URLType String Type of URL.


mailto The entry service point is formatted as an electronic mail address reference, for example, mailto:[email protected].

http The entry service point is formatted as an HTTP-compatible URL, for example, http://www.fabrikam.com/purchasing.

https The entry service point is formatted as a secure HTTP-compatible URL, for example, https://www.fabrikam.com/purchasing.

ftp The entry service point is formatted as a FTP directory address, for example, ftp://ftp.fabrikam.com/public.

fax The entry service point is formatted as a telephone number that will connect to a facsimile machine, for example, 1 425 555 5555.

phone The entry service point is formatted as a telephone number that will connect to voice or tone response based system, for example, 1 425 555 5555.

other The entry service point is formatted as some other address format. When this value is used, one or more of the pub.uddi.client.doc:tModel signatures found in the pub.uddi.client.doc:tModelInstanceInfo collection must specify that a particular format or transport type is required.


pub.uddi.client.doc:address

pub.uddi .c l ient .doc:addressWmUDDI. Document type that is a simple list of pub.uddi.client.doc:addressLine elements within the address container.

Parameters

See Also

pub.uddi.client.doc:addressLinepub.uddi.client.doc:tModel

pub.uddi .c l ient .doc:addressLineWmUDDI. Document type that contains the address line information.

addressLine elements contain string data with a line length limit of 80 character positions. Each addressLine element can contain two optional descriptive attributes, keyName and keyValue.

Parameters

@useType String Optional. Description of the type of address, for example, “billing department,” or “main office.”

@sortCode String Optional. Used to drive the behavior of external display mechanisms that sort addresses.

A value of... Indicates...

numeric Numeric ordering (for example, 1, 2, 3).

alphabetic Alphabetic ordering (for example, a, b, c).

first n Ordering of the first n positions of data in the address.

@tModelKey String Optional. Unique key reference that implies that the keyName keyValue pairs given by subsequent pub.uddi.client.doc:addressLine elements are to be interpreted by the taxonomy associated with the pub.uddi.client.doc:tModel that is referenced.

addressLine Document type List Optional. List of pub.uddi.client.doc:addressLine documents.

*body String Optional. Body of the address line.

@keyName String Optional. Key name of the address line.

@keyValue String Optional. Key value of the address line.



pub.uddi .c l ient .doc:assert ionStatusI temWmUDDI. Document type that contains the assertion status information.

It also forms the part of the pub.uddi.client.doc:assertionStatusReport document.

Parameters

See Also

pub.uddi.client.doc:assertionStatusReportpub.uddi.client.doc:businessEntitypub.uddi.client.doc:businessKey

@completionStatus String Assertion completion status.

Value Description

status:complete Returns only the publisher assertions that are complete.

status:toKey_incomplete Returns only those publisher assertions where the party that controls the pub.uddi.client.doc:businessEntity referenced by the toKey value has not made a matching assertion.

status:fromKey_incomplete Returns only those publisher assertions where the party that controls the pub.uddi.client.doc:businessEntity referenced by the fromKey value has not made a matching assertion.

tromKey String Unique key reference to the first pub.uddi.client.doc:businessEntity for which the assertion is made.

toKey String Unique key reference to the second pub.uddi.client.doc:businessEntity for which the assertion is made.

keyedReference Document type The relationship type for which the assertion is made.

keysOwned Document type List of the pub.uddi.client.doc:businessKey elements the publisher manages.


pub.uddi.client.doc:assertionStatusReport

pub.uddi .c l ient .doc:assert ionStatusReportWmUDDI. Document type that reports all complete and incomplete assertions and serves an administrative use, including determining if there are any outstanding, incomplete assertions about relationships involving businesses with which the publisher account is associated.

Parameters

pub.uddi .c l ient .doc:authTokenWmUDDI. Document type that contains a single authInfo element that contains an access token that is to be passed back in all Publisher’s API messages that change data.

Parameters

@generic String General information, such as version.

@operator String UDDI operator information.

assertionStatusItem Document type Optional. Assertion status information.

A value of... Indicates...






authInfo String An access token that is to be passed back in all Publisher’s API messages that change data.



Examples


samples.uddi.client:deleteMyBusinesssamples.uddi.client:publishMyBindingsamples.uddi.client:publishMyBusinesssamples.uddi.client:publishMyService

pub.uddi .c l ient .doc:bindingDetai lWmUDDI. Document type that consists of one or more bindingTemplate structures that are returned according to the data requested in the request message.

Parameters

Examples


samples.uddi.client:publishMyBinding

pub.uddi .c l ient .doc:bindingKeyWmUDDI. Document type that contains a unique key for a given bindingTemplate.

Parameters



@truncated String A flag that indicates whether or not to truncate the returned messages.


true The results are truncated to the value specified in maxrows.

false The results are not truncated.

bindingTemplate Document type Optional. Technical service description information related to a given business service family.

bindingKey String Unique key for a given bindingTemplate.


pub.uddi.client.doc:bindingTemplate

pub.uddi .c l ient .doc:bindingTemplateWmUDDI. Document type that holds technical service description information related to a given business service family.

Parameters

Examples



pub.uddi .c l ient .doc:bindingTemplatesWmUDDI. Document type that contains list of bindingTemplates.

Parameters

pub.uddi .c l ient .doc:businessDetai lWmUDDI. Document type that consists of one or more businessDetail structures that are returned according to the data requested in the request message.

Parameters

@serviceKey String Optional. Unique key for a given service.

@bindingKey String Unique key for a given bindingTemplate.

description Document type Optional repeating element. Zero or more language-qualified text descriptions of the technical service entry point.

accessPoint Document type Text field that is used to convey the entry point address suitable for calling a particular Web service.

hostingRedirector Document type Required element if accessPoint not provided. This element has a bindingKey attribute, giving the redirected reference to a different bindingTemplate.

tModelInstanceDetails Document type List of zero or more tModelInstanceInfo elements. This data, taken in total, should form a distinct fingerprint that can be used to identify compatible services.

bindingTemplate Document type List Technical service description information related to a given business service family.




Examples


samples.uddi.client:publishMyBusiness

pub.uddi .c l ient .doc:businessDetai lExtWmUDDI. Document type that consists of one or more businessDetailExt structures that are returned according to the data requested in the request message.

Parameters

pub.uddi .c l ient .doc:businessEnti tyWmUDDI. Document type that represents all known information about a business or entity that publishes descriptive information about the entity as well as the services that it offers.

Parameters






businessEntity Document type List List of pub.uddi.client.doc:businessEntity documents.







BusinessEntityExt Document type List List of businessEntityExt structures.

@businessKey String A unique UUID identifier for a specific instance of businessEntity.


@authorizedName String Recorded name of the individual that published the businessEntity data.


pub.uddi.client.doc:businessEntityExt

Examples


samples.uddi.client:create_businessEntity

pub.uddi .c l ient .doc:businessEnti tyExtWmUDDI. Document type that that contains a pub.uddi.client.doc:businessEntity document.

Parameters

pub.uddi .c l ient .doc:businessInfoWmUDDI. Document type that contains company name and optional description data, along with a collection element named serviceInfos that in turn can contain one or more serviceInfo structures.

Parameters

discoveryURLs Document type A discoverURLs document.

name Document type List of name documents.

description Document type List of description documents.

contacts Document type A contacts document.

businessServices Document type A businessServices document.

identifierBag Document type An identiferBag document.

categoryBag Document type A categoryBag document.

businessEntity Document type A pub.uddi.client.doc:businessEntity document.

@businessKey String A unique UUID identifier for a specific instance of pub.uddi.client.doc:businessEntity.

name Document type List List of name documents.

description Document type List List of description documents.

serviceInfos Document type List A serviceInfos document.



pub.uddi .c l ient .doc:businessInfosWmUDDI. Document type that consists of list of businessInfo documents.

Parameters

pub.uddi .c l ient .doc:businessKeyWmUDDI. Document type that contains the unique identifier for a given instance of a pub.uddi.client.doc:businessEntity structure.

Parameters

pub.uddi .c l ient .doc:businessListWmUDDI. Document type that contains zero or more businessInfos structures.

Parameters

businessInfo Document type List List of businessInfo documents.

@businessKey String A unique UUID identifier for a specific instance of pub.uddi.client.doc:businessEntity.







businessInfos Document type list List of businessInfos documents


pub.uddi.client.doc:businessService

pub.uddi .c l ient .doc:businessServiceWmUDDI. Document type that represents a logical service classification.

The name of the element includes the term “business” in an attempt to describe the purpose of this level in the service description hierarchy.

Parameters

Examples


samples.uddi.client:create_businessService

pub.uddi .c l ient .doc:businessServicesWmUDDI. Document type that lists the businessService documents.

Parameters

pub.uddi .c l ient .doc:categoryBagWmUDDI. Document type that allows pub.uddi.client.doc:businessEntity, businessService, and tModel structures to be categorized according to any of several available taxonomy based classification schemes.

Operator Sites automatically provide validated categorization support for three taxonomies that cover industry codes (via NAICS), product and service classifications (via UNSPC) and geography (via ISO 3166).

Parameters

@businessKey String Unique identifier for a given instance of a pub.uddi.client.doc:businessEntity structure.

@serviceKey String Unique key for a given service.



BindingTemplates Document type List A bindingTemplates document.

categoryBag Document type A categoryBag document.

businessService Document reference List List of businessService document.

keyedReference Document reference List List of keyedReference documents.



pub.uddi .c l ient .doc:contactWmUDDI. Document type that lets you record contact information for a person.

This information can consist of one or more optional elements, along with a person’s name. Contact information exists by containment relationship alone, and no mechanisms for tracking individual contact instances is provided by UDDI specifications.

Parameters

Examples



pub.uddi .c l ient .doc:contactsWmUDDI. Document type that provides a way for information to be registered with a pub.uddi.client.doc:businessEntity record so that someone that finds the information can make human contact for any purpose.

Parameters

Examples



@useType String Optional. Description of the type of contact in freeform text, for example, “sales contact,” or “technical services contact.”


personName String Name of the person or name of the job role.

phone Document type List Telephone numbers for the contact. List of phone documents.

email Document type List Email addresses for the contact. List of email documents.

address Document type List Printable lines suitable for addressing an envelope. List of email documents.

contact Document type List List of contact documents.


pub.uddi.client.doc:discoveryURL

pub.uddi .c l ient .doc:discoveryURLWmUDDI. Document type that consists of an attribute whose value designates the URL use type convention, and a string, found within the body of the element.

Each time a pub.uddi.client.doc:businessEntity structure is saved via a call to save_business, the UDDI Operator Site will generate one URL. The generated URL will point to an instance of either a pub.uddi.client.doc:businessEntity or businessEntityExt structure, and the useType attribute of the discoveryURL will be set to either "businessEntity" or "businessEntityExt" according to the data type found while processing the save_business message.

Parameters

Examples



pub.uddi .c l ient .doc:discoveryURLsWmUDDI. Document type that is used to hold pointers to URL addressable discovery documents.

Parameters

Examples



pub.uddi .c l ient .doc:disposit ionReportWmUDDI. Document type that is used to report status of various publish operations.

Parameters

*body String Body of the URL.

@useType String Name of the convention that the referenced document follows.

discoveryURL Document type List List of discoveryURL documents.






Examples


samples.uddi.client:deleteMyBusiness

pub.uddi .c l ient .doc:docType_categoryBagWmUDDI. Document type that allows pub.uddi.client.doc:businessEntity, businessService and tModel structures to be categorized according to any of several available taxonomy based classification schemes.

Operator Sites automatically provide validated categorization support for three taxonomies that cover industry codes (via NAICS), product and service classifications (via UNSPC) and geography (via ISO 3166).

Parameters

pub.uddi .c l ient .doc:docType_descript ionWmUDDI. Document type that contains the description with language resource information.

Parameters

pub.uddi .c l ient .doc:docType_keyedReferenceWmUDDI. Document type that designates the relationship type for which the assertion is made, represented by the included tModelKey and described by the included keyName keyValue pair.

Parameters




Result Document type list List of result documents.


*body String Body of the description.

@xml:lang String Language type of the description.

@tModelKey String Unique key reference to tModel.

@keyName String Key name.


pub.uddi.client.doc:docType_name

pub.uddi .c l ient .doc:docType_nameWmUDDI. Document type that describes a name.

Parameters

pub.uddi .c l ient .doc:emai lWmUDDI. Document type that describes the e-mail information.

Parameters

pub.uddi .c l ient .doc:err InfoWmUDDI. Document type that describes the error information.

Parameters

pub.uddi .c l ient .doc:f indQual i f ierWmUDDI. Document type that provides a means to allow the caller to override default search behaviors.

Parameters

@keyValue String Key value.

*body String Name.

@xml:lang String Language type of the description.

*body String E-mail information.

@useType String Description of the e-mail information.

*body String Error string.

@errCode String Error code.

findQualifier String Qualifier from a list of qualifiers.



pub.uddi .c l ient .doc:f indQual i f iersWmUDDI. Document type that contains a list of find qualifiers.

Parameters

pub.uddi .c l ient .doc:fromKeyWmUDDI. Document type that contains a UUID reference to a business Entity.

Parameters

pub.uddi .c l ient .doc:host ingRedirectorWmUDDI. Document type that is used to designate that a bindingTemplate entry is a pointer to a different bindingTemplate entry.

Parameters

pub.uddi .c l ient .doc: ident i f ierBagWmUDDI. Document type that is a general-purpose placeholder for any number of distinct identifiers.

Parameters

findQualifier String List List of find qualifiers.

fromKey String A UUID reference to a business Entity.

@bindingKey String Binding key.



pub.uddi.client.doc:instanceDetails

pub.uddi .c l ient .doc: instanceDetai lsWmUDDI. Document type that holds service instance specific information that is required to either understand the service implementation details relative to a specific tModelKey reference, or to provide further parameter and settings support.

Parameters

pub.uddi .c l ient .doc: instanceParmsWmUDDI. Document type that is used to contain settings parameters or a URL reference to a file that contains settings or parameters required to use a specific facet of a bindingTemplate description.

Parameters

pub.uddi .c l ient .doc:keyedReferenceWmUDDI. Document type that designates the relationship type for which the assertion is made, represented by the included tModelKey and described by the included keyName keyValue pair.

Parameters

description Document reference List Language-qualified text element that describes of the purpose and/or use of the particular instanceDetails entry. List of doctype_description documents.

overviewDoc Document type References to remote descriptive information or instructions related to proper use of a bindingTemplate technical sub-element. Contains a overviewDoc document.

instanceParms String Settings parameters or a URL reference to a file that contains settings or parameters required to use a specific facet of a bindingTemplate description.

instanceParms String Setting parameters or URL reference to a file that contains these settings.

@tModelKey String Unique key reference to tModel.

@keyName String Key name.

@keyValue String Key value.



pub.uddi .c l ient .doc:keysOwnedWmUDDI. Document type that designates those business keys the publisher manages.

Parameters

pub.uddi .c l ient .doc:overviewDocWmUDDI. Document type that is used to house references to remote descriptive information or instructions related to proper use of a bindingTemplate technical sub-element.

Parameters

pub.uddi .c l ient .doc:phoneWmUDDI. Document type that is used to hold telephone numbers for the contact.

This element can contain an optional useType attribute for descriptive purposes.

Parameters

Examples



FromKey String Unique key reference to the first pub.uddi.client.doc:businessEntity for which the assertion is made.

toKey String Unique key reference to the second pub.uddi.client.doc:businessEntity for which the assertion is made.

description Document type Language-qualified string containing a short descriptive overview of how a particular tModel is to be used.

overviewURL String URL reference to a long form of an overview document that covers the way a particular tModel specific reference is used as a component of an overall web service description.

*body String Telephone number.

@useType String More description of body.


pub.uddi.client.doc:publisherAssertion

pub.uddi .c l ient .doc:publ isherAssert ionWmUDDI. Document type that describes a publisher assertion structure.

Parameters

pub.uddi .c l ient .doc:publ isherAssert ionsWmUDDI. Document type that returns all assertions made by the publisher who was authenticated in the preceding set_publisherAssertions or the get_publisherAssertions API calls.

Parameters

pub.uddi .c l ient .doc:registeredInfoWmUDDI. Document type that contains overview information that is suitable for identifying all pub.uddi.client.doc:businessEntity and tModel data published by the requester.

Parameters

FromKey String Unique key reference to the first pub.uddi.client.doc:businessEntity for which the assertion is made.

toKey String Unique key reference to the second pub.uddi.client.doc:businessEntity for which the assertion is made

KeyedReference Document type Relationship type for which the assertion is made.



@authorizedName String Recorded name of the individual that published the pub.uddi.client.doc:businessEntity data.

publisherAssertion Document type List of PublisherAssertion document.









pub.uddi .c l ient .doc:relatedBusinessInfoWmUDDI. Document type that contains information about a pub.uddi.client.doc:businessEntity that relates to the specified pub.uddi.client.doc:businessEntity by at least one relationship.

Parameters

pub.uddi .c l ient .doc:relatedBusinessInfosWmUDDI. Document type that contains information about a pub.uddi.client.doc:businessEntity that relates to the specified pub.uddi.client.doc:businessEntity by at least one relationship.

Parameters

pub.uddi .c l ient .doc:relatedBusinessesListWmUDDI. Document type that contains list of related business lists.

Parameters

businessInfos Document type A businessInfos document.

tModelInfos Document type A tModelInfos document.




sharedRelationships Document type A sharedRelationships document.




sharedRelationships Document type A sharedRelationships document.





pub.uddi.client.doc:result

pub.uddi .c l ient .doc:resultWmUDDI. Document type that defines the result structure.

Parameters

pub.uddi .c l ient .doc:schema_uddiv2WmUDDI. Schema created using the webMethods schema generator as part of creating document types. It is created from the XSD document specified by UDDI Version 2.0 UDDI XML Schema 2001.

pub.uddi .c l ient .doc:serviceDetai lWmUDDI. Document type that contains complete descriptive and technical details about registered services.

Parameters





relatedbusinessInfos Document type List of relatedbusinessInfos documents.

@keyType String Key type.

@errno String The error identifier

errInfo Document type The errInfo document.







businessService Document type List of businessService documents.


http://uddi.org/schema/uddi_v2.xsd


Examples


samples.uddi.client:findAllServicesOfBusinesssamples.uddi.client:publishMyService

pub.uddi .c l ient .doc:serviceInfoWmUDDI. Document type that are abbreviated versions of businessService data, suitable for populating a list of services associated with a business and that match a pattern as specified in the inputs to the find_service API.

Parameters

pub.uddi .c l ient .doc:serviceInfosWmUDDI. Document type that consists of list of serviceInfo documents.

Parameters

pub.uddi .c l ient .doc:serviceKeyWmUDDI. Document type that is a UUID key to identify a service.

Parameters

pub.uddi .c l ient .doc:serviceListWmUDDI. Document type that contains list of serviceInfo documents.

Parameters


businessKey String Unique identifier for a given instance of a pub.uddi.client.doc:businessEntity structure.


serviceInfo Document type List List of serviceInfo documents.




pub.uddi.client.doc:sharedRelationships

pub.uddi .c l ient .doc:sharedRelat ionshipsWmUDDI. Document type that contains the keyed references and direction to it.

Parameters

pub.uddi .c l ient .doc:SOAPFaultWmUDDI. Document type that contains the SOAP Fault structure.

Parameters

pub.uddi .c l ient .doc:tModelWmUDDI. Document type that takes the form of keyed metadata (data about data). In a general sense, the purpose of a tModel within the UDDI registry is to provide a reference system based on abstraction.

The information that makes up a tModel is quite simple. There’s a key, a name, an optional description, and then a URL that points to a location to go to find out more about the actual concept represented by the metadata in the tModel itself.






serviceInfo Document type List List of serviceInfo documents.

@direction String Direction to keyedReference document.


faultcode String Optional. SOAP Fault code.

faultstring String Optional. SOAP Fault string.

faultactor String Optional. SOAP Fault actor.

detail Document type Optional. Details of the fault. The detail structure contains the pub.uddi.client.doc:dispositionReport document.



Parameters

pub.uddi .c l ient .doc:tModelBagWmUDDI. Document type that contains a list of tModelKeys.

Parameters

pub.uddi .c l ient .doc:tModelDetai lWmUDDI. Document type that contains list of tModel documents.

Parameters

tModelKey String Unique key for a given tModel structure.

@operator String Certified name of the UDDI registry site operator that manages the master copy of the tModel data.

@authorizedName String Recorded name of the individual that published the tModel data.

Name Document type List Name recorded for the tModel. Name search is provided via find_tModel call.

description Document type List One or more short language-qualified descriptions.

overviewDoc Document type List References to remote descriptive information or instructions related to the tModel.

identifierBag Document type List Optional. List of name-value pairs that can be used to record identification numbers for a tModel.

categoryBag Document type List Optional. List of name-value pairs that are used to tag a tModel with specific taxonomy information.

tModelKey String List List unique key for a given tModel structure.







tModel Document type List List of tModel documents. The structure of this document is defined in pub.uddi.client.doc:tModel.


pub.uddi.client.doc:tModelInfo

pub.uddi .c l ient .doc:tModel InfoWmUDDI. Document type that contains overview data about business and tModel information published by a given publisher.

Parameters

Examples



pub.uddi .c l ient .doc:tModel InfosWmUDDI. Document type that consists of list of tModelInfo documents.

Parameters

pub.uddi .c l ient .doc:tModel InstanceDetai lsWmUDDI. Document type that is a simple accessor container for one or more pub.uddi.client.doc:tModelInstanceInfo documents.

Parameters

pub.uddi .c l ient .doc:tModel InstanceInfoWmUDDI. Document type that is a tModelInstanceInfo structure representing the bindingTemplate instance specific details for a single tModel by reference.

Parameters

tModelKey String Unique key for a given tModel structure. The structure of this document is defined in pub.uddi.client.doc:tModelKey.

name Document type List Name recorded for the tModel. Name search is provided via find_tModel call.

tModelInfo Document type List List of tModelInfo documents.

tModelInstanceInfo Document type List List of tModelInstanceInfo documents.

@tmodelKey String Unique key for a given tModel structure.



Examples



pub.uddi .c l ient .doc:tModelKeyWmUDDI. Document type that contains a tModelKey UUID.

Parameters

pub.uddi .c l ient .doc:tModelListWmUDDI. Document type that contains zero or more tModelInfo structures in response to a find_tModel inquiry message.

Parameters

description Document type List List of description documents. This is one or more language-qualified text descriptions that designate what role a tModel reference plays in the overall service description.

instanceDetails Document type List An instanceDetail document. This element can be used when tModel reference specific settings or other descriptive information are required to either describe a tModel specific component of a service description or support services that require additional technical data support (for example, via settings or other handshake operations)

@tmodelKey String Unique key for a given tModel structure.







tModelInfos Document type List List of tModelInfo documents.


pub.uddi.client.doc:toKey

pub.uddi .c l ient .doc:toKeyWmUDDI. Document type that contains the toKey UUID.

Parameters

pub.uddi .c l ient .doc:uploadRegisterWmUDDI. Document type that contains the uploadRegister string.

Parameters

pub.uddi .c l ient . inquiry:f ind_bindingWmUDDI. Locates specific bindings within a registered business service.

It then returns a bindingDetail message containing zero or more bindingTemplate structure matching the criteria specified in the argument list. Only the bindings specified by serviceKey will be searched.

Input Parameters

Output Parameters

toKey String Unique key reference to the second pub.uddi.client.doc:businessEntity for which the assertion is made

uploadRegister String The uploadRegister key.

inquiryURL String URL indicating the path of the UDDI server.

serviceKey String A UUID key to specify a particular instance of a businessService element.

maxRows String Optional. Maximum number of results returned in response to a service call.

findQualifiers String List Optional. FindQualifier elements to alter the default behavior of search functionality. Details about findQualifier is available in Appendix E of the UDDI specification.

tModelBag Document type List of tModel UUID keys that represent the technical fingerprint of a bindingTemplate.

rawXMLResponse String Raw XML response from the UDDI server.

document Document type The returned businessDetail object that contains the binding template information.

SOAPFault Document type SOAP Fault information.



pub.uddi .c l ient . inquiry:f ind_businessWmUDDI. Locates one or more businesses. It then returns a businessList message that matches the conditions specified in the argument.

Input Parameters

Output Parameters-

status String Status of this service.


0 The service completed successfully.

1 The service terminated on a SOAP fault from the UDDI server.

2 The service did not complete due to an HTTP connection error, for example, HTTP 404.

-1 The service did not complete due to another error condition, for example, ServiceException.


businessNameList String List Optional. List of names of business to search.



tModelBag Document type Optional. List of tModel UUID keys that represent the technical fingerprint of a bindingTemplate.

identifierBag Document type Optional. List of business identifier references.

categoryBag Document type Optional. List a list of category references.

discoveryURLs Document type Optional. List of URLs to be matched against the discoveryURL data associated with any registered pub.uddi.client.doc:businessEntity information.


document Document type The returned businessList object that contains the business, and summaries of the businessServices.




pub.uddi.client.inquiry:find_businessByCategory

pub.uddi .c l ient . inquiry:f ind_businessByCategoryWmUDDI. Locates one or more businesses based on category references passed.

Input Parameters

Output Parameters







Marrows String Optional. A limit to the number of results returned.


categoryBag Document type A list of category references.


document Document type The returned businessList object that contains the business, and summaries of the businessServices.










pub.uddi .c l ient . inquiry:f ind_businessByDiscURLsWmUDDI. Locates one or more businesses based on discoveryURLs.

Input Parameters

Output Parameters

pub.uddi .c l ient . inquiry:f ind_businessByIdent i tyWmUDDI. Locates one or more businesses based on business identifier references.

Input Parameters




discoveryURLs Document type Optional. List of URLs to be matched against the discoveryURL data associated with any registered pub.uddi.client.doc:businessEntity information.


Document Document type The returned businessDetail object that contains the binding template information.











pub.uddi.client.inquiry:find_businessByName

Output Parameters

pub.uddi .c l ient . inquiry:f ind_businessByNameWmUDDI. Locates one or more businesses based on names.

Input Parameters

Output Parameters




Document Document type The returned businessList object that contains the business, and summaries of the businessServices.











businessNameList String List Optional. List of names of business to search.




Examples


samples.uddi.client:findAllServicesOfBusiness

pub.uddi .c l ient . inquiry:f ind_businessBytModelWmUDDI. Locates one or more businesses based on tModel references.

Input Parameters

Output Parameters










Marrows String Optional. Maximum number of results returned.


tModelBag Document type List of tModel UUID keys that represent the technical fingerprint of a bindingTemplate.






pub.uddi.client.inquiry:find_relatedBusinesses

pub.uddi .c l ient . inquiry:f ind_relatedBusinessesWmUDDI. Locates information about pub.uddi.client.doc:businessEntity registrations that are related to the specific business entity whose key is passed in the inquiry.

The service returns a relatedBusinessList document type.

Input Parameters

Output Parameters










keyedReference Document type Optional. Used to specify that only businesses that related to the focal point in a specific way should be included in the results.


Document Document type The returned relatedBusinessList object.








pub.uddi .c l ient . inquiry:f ind_serviceWmUDDI. Locates specific services within a registered pub.uddi.client.doc:businessEntity.

The service returns a serviceList message that matches the conditions specified in the arguments.

Input Parameters

Output Parameters







tModelBag Document type List of tModel UUID keys that represent the technical fingerprint of a bindingTemplate to find.

categoryBag Document type List of category references.

ServiceNameList String List Optional. List of names of services to be searched.


Document Document type The returned serviceList object.








pub.uddi.client.inquiry:find_serviceByBusKey

pub.uddi .c l ient . inquiry:f ind_serviceByBusKeyWmUDDI. Locates specific services within a registered pub.uddi.client.doc:businessEntity based on business key identifier.


Input Parameters

Output Parameters

















pub.uddi .c l ient . inquiry:f ind_serviceByCategoryWmUDDI. Locates specific services within a registered pub.uddi.client.doc:businessEntity based on list of category key identifiers.


Input Parameters

Output Parameters















pub.uddi.client.inquiry:find_serviceByName

pub.uddi .c l ient . inquiry:f ind_serviceByNameWmUDDI. Locates specific services within a registered pub.uddi.client.doc:businessEntity based on list of service names.


Input Parameters

Output Parameters


Document Document type Stores the serviceList object.


ServiceNameList String List List of names of services to be searched.













pub.uddi .c l ient . inquiry:f ind_serviceBytModelWmUDDI. Locates specific services within a registered pub.uddi.client.doc:businessEntity based on list of tModel references.


Input Parameters

Output Parameters




tModelBag Document type [pub.uddi.client.doc:tModelBag]List of tModel UUID keys that represent the technical fingerprint of a bindingTemplate.











pub.uddi.client.inquiry:find_tModel

pub.uddi .c l ient . inquiry:f ind_tModelWmUDDI. Locates one or more tModel information structures matching the set of specific criteria.

The response is returned in the tModelList message.

Input Parameters

Output Parameters


tModelName String Optional. tModel name.




categoryBag Document type Optional. List of category references.


Document Document type The returned tModelList object.










pub.uddi .c l ient . inquiry:f ind_tModelByCategoryWmUDDI. Locates one or more tModel information structures based on list of category references.

The found tModel information is returned in the tModelList message.

Input Parameters

Output Parameters

pub.uddi .c l ient . inquiry:f ind_tModelByIdent i tyWmUDDI. Locates one or more tModel information structures based on list of business identity references.


Input Parameters
















pub.uddi.client.inquiry:find_tModelByName

Output Parameters

pub.uddi .c l ient . inquiry:f ind_tModelByNameWmUDDI. Locates one or more tModel information structures based on list of business identity references.


Input Parameters














tModelName String Optional. tModel name.





Output Parameters

pub.uddi .c l ient . inquiry:get_bindingDetai lWmUDDI. Retrieves full binding template information suitable for making one or more service requests.

The information is returned in bindingDetail message.

Input Parameters

Output Parameters











bindingKeyList String List One or more UUID key values that represent the UDDI assigned keys for specific instances of registered bindingTemplate data.


Document Document type The returned bindingDetail object.







pub.uddi.client.inquiry:get_businessDetail

pub.uddi .c l ient . inquiry:get_businessDetai lWmUDDI. Retrieves the full pub.uddi.client.doc:businessEntity information for one or more businesses or organizations.

The information is returned in the businessDetail document type.

Input Parameters

Output Parameters




businessKeyList String List One or more UUID key values that represent UDDI assigned businessKey values for specific instances of known pub.uddi.client.doc:businessEntity data.


Document Document type The returned businessDetail object.










pub.uddi .c l ient . inquiry:get_businessDetai lExtWmUDDI. Retrieves extended pub.uddi.client.doc:businessEntity information for one or more specified pub.uddi.client.doc:businessEntity registrations.

This message returns exactly the same information as the get_businessDetail document, but may contain additional attributes if the source is an external registry (for example, not an Operator Site) that is compatible with this API specification.

Input Parameters

Output Parameters

pub.uddi .c l ient . inquiry:get_serviceDetai lWmUDDI. Retrieves full details for a given set of registered businessService data.

The data is returned in serviceDetail document.

Input Parameters


businessKeyList String List One or more UUID key values that represent UDDI assigned businessKey values for specific instances of known pub.uddi.client.doc:businessEntity data.












pub.uddi.client.inquiry:get_tModelDetail

Output Parameters

Examples


samples.uddi.client:findAllServicesOfBusiness

pub.uddi .c l ient . inquiry:get_tModelDetai lWmUDDI. Retrieves full details for a given set of registered tModel data.

The service returns a tModelDetail message.

Input Parameters

Output Parameters

serviceKeyList String List The UUID key values that represent UDDI assigned serviceKey values of specific instances of known businessService data.


Document Document type The returned serviceDetail object.









tModelKeyList String List One or more URN qualified uuid_key values that represent UDDI assigned tModelKey values of specific instances of known tModel data.


Document Document type The returned tModelDetail object.




pub.uddi .c l ient .publ ish:add_publ isherAssert ionsWmUDDI. Adds relationship assertions to the existing set of assertions.

Input Parameters

Output Parameters







publishURL String URL indicating the path of the UDDI server.

authInfo String Authentication token.

publisherAssertionList Document type One or more relationship assertions.


Document Document type The returned dispositionReport object.









pub.uddi.client.publish:delete_binding

pub.uddi .c l ient .publ ish:delete_bindingWmUDDI. Deletes one or more instances of bindingTemplate data from the UDDI registry.

Input Parameters

Output Parameters

pub.uddi .c l ient .publ ish:delete_businessWmUDDI. Removes one or more business registrations (for example, registered pub.uddi.client.doc:businessEntity data) and all direct contents from a UDDI registry.

Input Parameters



bindingKeyList String List One or more UUID key values that represent specific instances of known bindingTemplate data.












businessKeyList String List One or more UUID key values that represent specific instances of known pub.uddi.client.doc:businessEntity data.



Output Parameters

Examples


samples.uddi.client:deleteMyBusiness

pub.uddi .c l ient .publ ish:delete_publ isherAssert ionsWmUDDI. Removes one or more publisherAssertion elements to be removed from a publisher’s assertion collection.

Input Parameters

Output Parameters












publisherAssertionList Document type One or more relationship assertion structures exactly matching an existing assertion that can be found in the publisher’s assertion.






pub.uddi.client.publish:delete_service

pub.uddi .c l ient .publ ish:delete_serviceWmUDDI. Removes one or more previously businessService elements from the UDDI registry and from its containing pub.uddi.client.doc:businessEntity parent.

Input Parameters

Output Parameters








serviceKeyList String List One or more UUID key values that represent specific instances of known businessService data.












pub.uddi .c l ient .publ ish:delete_tModelWmUDDI. Logically deletes one or more tModel structures. Logical deletion hides the deleted tModels from find_tModel result sets, but does not physically delete it.

Deleting an already deleted tModel has no effect.

Input Parameters

Output Parameters

pub.uddi .c l ient .publ ish:discard_authTokenWmUDDI. Informs an Operator Site that the authentication token is to be discarded, effectively ending the session.

Subsequent calls that use the same authToken will be rejected. This message is optional for Operator Sites that do not manage session state or that do not support the get_authToken message.

Input Parameters



TmodelKeyList String List One or more URN qualified UUID key values that represent UDDI assigned tModelKey values of specific instances of known tModel data.













pub.uddi.client.publish:get_assertionstatusReport

Output Parameters

Examples



pub.uddi .c l ient .publ ish:get_assert ionstatusReportWmUDDI. Provides administrative support for determining the status of current and outstanding publisher assertions that involve any of the business registrations managed by the individual publisher account.

Using this message, a publisher can see the status of assertions that they have made, as well as see assertions that others have made that involve pub.uddi.client.doc:businessEntity structures controlled by the calling publisher account.

Input Parameters




status String Status of this API call.








completionstatus String Optional. One of the following values:



Output Parameters

pub.uddi .c l ient .publ ish:get_authTokenWmUDDI. Obtains an authentication token.

Authentication tokens are opaque values that are required for all other publisher API calls. This API is provided for implementations that do not have some other method of obtaining an authentication token or certificate, or that choose to use user ID and password based authentication.

Input Parameters

Value Description





Document Document type The returned assertionstatusReport object.










pub.uddi.client.publish:get_publisherAssertions

Output Parameters

Examples



pub.uddi .c l ient .publ ish:get_publ isherAssert ionsWmUDDI. Obtains the full set of publisher assertions that is associated with an individual publisher account.

Input Parameters

Output Parameters

uddiUserID String User ID that the individual authorized user was assigned by an Operator Site.

uddiPassword String The password or credential that is associated with the user ID.


Document Document type The returned authToken object.


status String Status of this API call.











pub.uddi .c l ient .publ ish:get_registeredInfoWmUDDI. Gets an abbreviated list of all pub.uddi.client.doc:businessEntity and tModel data that are controlled by the individual associated with the credentials passed.

Input Parameters

Output Parameters

Document Document type The returned publisherAssertions object.











Document Document type The returned registeredInfo object.









pub.uddi.client.publish:save_binding

pub.uddi .c l ient .publ ish:save_bindingWmUDDI. Saves or updates a complete bindingTemplate element.

This message can be used to add or update one or more bindingTemplate elements as well as the container/contained relationship that each bindingTemplate has with one or more existing businessService elements.

Input Parameters

Output Parameters

Examples


samples.uddi.client:publishMyBinding

pub.uddi .c l ient .publ ish:save_businessWmUDDI. Saves or updates information about a complete pub.uddi.client.doc:businessEntity element.

The pub.uddi.client.publish:save_business service has the broadest scope of all of the save_xx services, and can be used to make sweeping changes to the published information for one or more pub.uddi.client.doc:businessEntity elements.



bindingTemplateList Document type One or more complete bindingTemplate elements.


Document Document type The returned bindingDetail object.










Input Parameters

Output Parameters

Examples


samples.uddi.client:publishMyBusiness

pub.uddi .c l ient .publ ish:save_serviceWmUDDI. Adds or updates one or more businessService elements.

Input Parameters

Output Parameters



businessEntityList Document type One or more complete pub.uddi.client.doc:businessEntity elements.












businessServiceList Document type One or more complete businessService elements can be passed.


Document Document type The returned serviceDetail object.


pub.uddi.client.publish:save_tModel

Examples


samples.uddi.client:publishMyService

pub.uddi .c l ient .publ ish:save_tModelWmUDDI. Adds or updates one or more registered tModel elements.

Input Parameters

Output Parameters










tModelList Document type One or more complete tModel elements can be passed.


Document Document type The returned tModelDetail object.









pub.uddi .c l ient .publ ish:set_publ isherAssert ionsWmUDDI. Manages all of the tracked relationship assertions associated with an individual publisher account.

Input Parameters

Output Parameters




PublisherAssertionList Document type Optional. Zero or more relationship assertions.

rawXMLResponse String Raw XML response from the Usamples.uddi.client.DDI server.

Document Document type The returned publisherAssertions object.









C H A P T E R34
UniversalName Folder
You use the elements in the universalName folder to list the contents of the Universal Registry and to look up services by their universal names.


C H A P T E R 3 4 U n i v e r s a l N a m e F o l d e r


pub.universalName:f indWmPublic. Returns the fully qualified service name for an explicit universal name.

Input Parameters

Output Parameters

pub.universalName:l istWmPublic. Returns the contents of the current universal-name registry.

Input Parameters

None.

Output Parameters


pub.universalName:find WmPublic. Returns the fully qualified service name for an explicit universal name.

pub.universalName:list WmPublic. Returns the contents of the current universal-name registry.

namespaceName String Namespace portion of the universal name.

localName String Local portion of the universal name.

svcName String Conditional. Fully qualified name of the service associated with the universal name in namespaceName and localName. If the specified universal name is not in the registry, svcName will be null.

names Document List Entries in the universal name registry. Each document (IData object) in the list represents an entry in the universal-name registry. (There is one entry for every explicit universal name that has been defined on the server. Implicit universal names are not maintained in the registry.)

Each document in the list contains the following information:


pub.universalName:list

Key Description

universalName Document The universal name associated with the entry. This document contains the following information:

Key Description

namespaceName String Namespace portion of the universal name.

localName String Local portion of the universal name.

svcName String Fully qualified webMethods service name associated with the entry (for example, gl.post:postEntry).


C H A P T E R 3 4 U n i v e r s a l N a m e F o l d e r


C H A P T E R35
Web Folder
You use the elements in the web folder to perform operations on XML and HTML documents.

Important! The services in this folder have been deprecated. To operate on XML and HTML documents, use the services in the xml folder.


C H A P T E R 3 5 W e b F o l d e r


pub.web:createRegionsWmPublic. Deprecated—Defines regions, which are named portions of an HTML or XML document between two delimiting nodes.

Input Parameters


pub.web:createRegions WmPublic. Deprecated—Defines regions, which are named portions of an HTML or XML document between two delimiting nodes.

pub.web:documentToRecord WmPublic. Deprecated—Use pub.xml:xmlNodeToDocument. Converts an XML node to an IData object.

pub.web:freeDocument WmPublic. Deprecated—Use pub.xml:freeXMLNode. Frees the resources allocated for a given XML node.

pub.web:getDocumentType WmPublic. Deprecated—Use pub.xml:getXMLNodeType. Returns information about an XML node.

pub.web:getNextNode WmPublic. Deprecated—Use pub.xml:getNextXMLNode. Gets the next node from a NodeIterator.

pub.web:getNodeIterator WmPublic. Deprecated—Use pub.xml:getXMLNodeIterator. Creates and returns a NodeIterator.

pub.web:loadDocument WmPublic. Deprecated—Use pub.xml:loadXMLNode. Retrieves an XML or HTML document via HTTP or HTTPS, parses it, and returns an XML node.

pub.web:makeArrays WmPublic. Deprecated—Produces a list of the repeating elements in an XML document based on the document’s DTD.

pub.web:queryDocument WmPublic. Deprecated—Use pub.xml:queryXMLNode. Queries an XML node.

pub.web:recordToDocument WmPublic. Deprecated—Use pub.xml:documentToXMLString. Converts a document (IData object) to an XML String.

pub.web:stringToDocument WmPublic. Deprecated—Use pub.xml:xmlStringToXMLNode. Converts an XML document (represented as a String, byte[ ], or InputStream) to an XML node.

node com.wm.lang.xml.Node XML node from which you want to create regions.


pub.web:createRegions

nsDecls Document Optional. Namespaces associated with any namespace prefixes used in regions/start/query and regions/end/query. Each entry in nsDecls represents a namespace prefix/URI pair, where a key name represents a prefix and the value of the key specifies the namespace URI.

For example, to define the URIs associated with two prefixes called GSX and TxMon, you would set nsDecls as follows:

regions Document List Region definitions. A region is a portion of an HTML or XML document between two delimiting nodes, possibly including either or both delimiting nodes. Each document in regions describes a single region as follows:

Key Description

name String Name to assign to the resulting region.

structured String Optional. Not used. Reserved for future use.

start Document Optional. Parameters that define the starting node of the region. When start is not specified, the region starts with the first node and includes the first node. Specify start as follows:

Key Description

queryType String Query language in which the query for the starting node is expressed. Valid values are WQL and XQL.

query String Query identifying the starting node. If the identified node cannot be found, the region is not produced.

include String Flag indicating whether to include the starting node in the region.

Set to... To...

true Include the starting node in the region.

false Exclude the starting node from the region.

end Document Optional. Parameters that define the ending node of the region. When end is not specified, the region ends with the last node and includes the last node. Specify end as follows:



Output Parameters

Values retrieved by the regions input specifications. There will be one output parameter for each region, which will go directly into the IData object passed to the service (usually the IData object representing the pipeline).

pub.web:documentToRecordWmPublic. Deprecated—Use pub.xml:xmlNodeToDocument. Converts an XML node to an IData object.

This service transforms each element and attribute in the XML node (a parsable representation of an XML document) to an element in an IData object. For example:

Key Description

queryType String Query language in which the query for the ending node is expressed. Valid values are WQL and XQL.

query String Query identifying the ending node. If the identified node cannot be found, the region cannot be found.

include String Flag indicating whether to include the ending node in the region.

Set to... To...

true Include the ending node in the region.

false Exclude the ending node from the region.

Key Description

pattern String Not implemented.

nullok String Optional. Flags that indicates whether the service should fail if the resulting region is null.

Set to... To...

true Default. Signal failure when region is null.

false Signal success even if region is null.


pub.web:documentToRecord

Note that:

The XML version attribute is converted to an element named @version.

The resulting IData is given the same name as the XML document’s root element (AcctInfo in the example above) and is a child of the boundNode IData that this service returns.

Simple elements (such as <name> and <rep> in the example above) are converted to String elements within the parent IData.

Complex elements (that is, elements with children, such as <address> in the example above) and simple elements that have attributes (such as <acctNum> and <phoneNum>) are converted to IData objects within the parent IData. Note that keys derived from attributes are prefixed with a ‘@’ character to distinguish them from keys derived from elements. Also note that when a simple element has an attribute, its value is placed in an element named *body.

Repeated elements (such as <serialNum>) can be collected into arrays using the makeArrays and/or arrays parameters. See makeArrays and arrays below for additional information about producing arrays from the source document.

This service would convert this XML document... To an IData that looks like this...

<?xml version="1.0" ?><AcctInfo> <name>Midwest Extreme Sports</name> <rep>Laura M. Sanchez</rep> <acctNum type=platinum>G97041A</acctNum> <phoneNum cc=011>216-741-7566</phoneNum> <address county=USA> <street1>10211 Brook Road</street1> <city>Cleveland</city> <state>OH</state> <postalCode>22130</postalCode> </address> <serialNum>19970523A</serialNum> <serialNum>20001106G</serialNum> <serialNum>20010404K</serialNum></AcctInfo>



Input Parameters

node com.wm.lang.xml.Node XML node that is to be converted to a document.

attrPrefix String Optional. Prefix to be used to designate keys containing attribute values. The default is “@”.

For example, if you set attrPrefix to ATT_ and node contained the following element:<tx currency=dollars> <acct>cash</acct> <amt>120.00</amt></tx>

documentToRecord would convert the currency attribute as follows:

arrays String List Optional. Names of elements that are to be generated as arrays, regardless of whether they appear multiple times in node. For example, if arrays contains the following values for the XML document shown in Description above:

repaddress

documentToRecord would generate element rep as a String list and element address as a document list. You may optionally include namespace prefixes in the element names that you specify in arrays; however, if you do, you must define the namespaces associated with those prefixes in nsDecls.

makeArrays String Optional. Flag indicating whether you want documentToRecord to automatically create an array for every element that appears in node more than once.

Set to... To...

true Default. Automatically create arrays for every element that appears more than once in node.

false Create arrays for only those elements specified in arrays or defined as arrays in the document type specified in recordName.

Important! You must set makeArrays to false when using recordName to define the structure of an element. Otherwise, an exception will be thrown at run time.



collect Document Optional. Elements that are to be placed into a new, named array (that is, a “collection”). Within collect, set the key names to specify the names of those elements that are to be included in the collection. Set the value of each key to the name of the collection in which you want that element placed. For example, if you wanted to place <name> and <rep> in an array called originator, you would set collect as follows:

Key Value

name originator

rep originator

If the set of elements placed in a collection are all simple elements, a String List (a String[ ]) will be produced. If the set is made up of complex elements, or a combination of simple and complex elements, a Document List (an IData[ ]) will be produced. In this case, each member of the array will include a child element called *name that contains the name of the element from which that member was derived.

You may optionally include namespace prefixes in the element names that you specify in collect; however, if you do, you must define the namespaces associated with those prefixes in nsDecls.

Important! You cannot include an element in more than one collection.

nsDecls Document Optional. Namespace prefixes to use for the conversion. This parameter specifies the prefixes that will be used when namespace-qualified elements are converted to key names in the resulting IData object. For example, if you want elements belonging to a particular namespace to have the prefix GSX in the resulting IData (for example, GSX:acctNum), you would associate the prefix GSX with that namespace in nsDecls. (This is important because incoming XML documents can use any prefix for a given namespace, but the key names expected by a target service or MAP step on the Integration Server will have a fixed prefix.)

Namespace prefixes in nsDecls also define the prefixes used by the arrays, records, recordName, and collect parameters.

Each entry in nsDecls represents a namespace prefix/URI pair, where a key name represents a prefix and the value of the key specifies the namespace URI.




records String List Optional. Names of any simple elements that are to be generated as documents (IData objects) instead of Strings. The document produced for each element specified in records will have the same name as the source element from which it was derived and will contain a String element named *body that holds the element’s value.

For example, if records contained the Strings name and rep and the source document contained the following:

. . .<name>Midwest Extreme Sports</name><rep>Laura M. Sanchez</rep> . . .

documentToRecord would produce the following:

recordName String Optional. Fully qualified name of a document type that defines the structure that is to be imposed on the elements in the resulting document (IData object). You can use this parameter to explicitly specify the order and dimensionality of elements. It is an alternative to using makeArrays and arrays to specify which elements are to be generated as arrays.

For example, if you had the XML document shown in the description of this service, and you wanted the <name> and <rep> elements to be generated as String Lists, you would define them as such in a document type and then specify that document type in recordName.

Note: recordName does not need to specify every element that will appear in the resulting document. It only needs to specify those elements whose structure you want to explicitly set.

Important! When you use recordName, set makeArrays to false and do not set arrays or records. Otherwise, documentToRecord will throw an exception at run time.



Output Parameters

Usage Notes

Following are examples of XML documents and the documents (IData objects) that documentToRecord would produce.

mixedModel String Optional. Flag specifying how mixed-content elements (elements containing both text values and child elements) are to be converted.

The following is an example of a mixed-content element:<comment> This job is <status>pending</status>. Estimated completion date is <edc>Feb 14, 2000</edc>.</comment>

Set to... To...

true Place text in an element named *body. This setting would produce the following document for the <comment> element shown above:

Important! When you set mixedModel to true, you must also use recordName to specify a document type that describes the structure of the document that you want documentToRecord to produce. Within the document type, mixed-content elements must be defined as documents that include a String field named *body.

false Omit top-level text and include only the child elements from mixed-content elements. This setting would produce the following document for the <comment> element shown above:

document Document Document (IData object) representation of the nodes and attributes in node.



XML Document Output generated by documentToRecord

<myDoc> <e1>e1Value</e1></myDoc>

<?xml version="1.0" encoding="UTF-8" standalone="no"?><myDoc> <e1>e1Value</e1></myDoc>

<?xml version="1.0" encoding="UTF-8" standalone="no"?><myDoc> <e1 e1Attr="attrValue">e1Value</e1></myDoc>

<?xml version="1.0" encoding="UTF-8" standalone="no"?><myDoc> <e1>e1Value</e1> <e2>e2Value</e2></myDoc>

<?xml version="1.0" encoding="UTF-8" standalone="no"?><myDoc> <e1>e1Value1</e1> <e2>e2Value</e2> <e1>e1Value2</e1></myDoc>



<?xml version="1.0" encoding="UTF-8"?><myDoc> <e1 e1Attr="attrValue1">e1Value1</e1> <e2>e2Value</e2> <e1 e1Attr="attrValue2">e1Value2</e1></myDoc>

Note: This example assumes that makeArrays is set to true. Note that an array e1 was created, which holds both <e1> elements that were in the source document.


Note: This example assumes that makeArrays is set to false. Note that only the last <e1> element in the source document was retained in the resulting IData.




pub.web:freeDocumentWmPublic. Deprecated—Use pub.xml:freeXMLNode. Frees the resources allocated for a given XML node.

You can optionally call this service when you are using a NodeIterator to iterate over an XML node and you decide to stop processing the node before reaching the end. By explicitly calling freeDocument, you immediately free the resources associated with the node instead of waiting for Java garbage collection to do this. Although it is not mandatory to call this service when you finish processing an XML node with a NodeIterator, doing so can boost server performance. Note that after you have freed an XML node using this service, the node becomes unstable and should not be used by any subsequent processes.

Input Parameters

Output Parameters

None.

pub.web:getDocumentTypeWmPublic. Deprecated—Use pub.xml:getXMLNodeType. Returns information about an XML node.

Input Parameters

<?xml version="1.0" encoding="UTF-8"?><myDoc> <e1 e1Attr="attrValue1">e1Value1</e1> <e2> <e3>e3Value</e3> <e4 e4Attr="attrValue4" 4Attrb="attrValue4b">e4Value </e4> </e2></myDoc>


document com.wm.lang.xml.Document XML node whose resources you want to release.

document com.wm.lang.xml.Document XML node about which you want information.


pub.web:getNextNode

Output Parameters

pub.web:getNextNodeWmPublic. Deprecated—Use pub.xml:getNextXMLNode. Gets the next node from a NodeIterator.

A NodeIterator is acquired via the service pub.web:getNodeIterator (deprecated) or pub.xml:getXMLNodeIterator. Output is a document (IData object) containing the element type name of the node and the node itself. The instance of this document is only valid until the next getNextNode call on the same NodeIterator, because getNextNode uses the same document object for each call.

Input Parameters

Output Parameters

systemID String System identifier, as provided by the DTD associated with the document. If document does not have a system identifier, this value is null.

publicID String Public identifier, as provided by the DTD associated with the document. If document does not have a public identifier, this value is null.

rootNamespaceURI String URI of the XML namespace to which the document’s root element belongs, if any.

rootNSPrefix String Namespace prefix of the root element in the document, if any.

rootLocalName String Local name (excluding the namespace prefix) of the root element in the document.

iterator com.wm.app.b2b.util.NodeIterator NodeIterator from which to retrieve the next node.

next Document Conditional. The requested node. Will be null when the NodeIterator has no more nodes to return. Otherwise, next will contain the following:

Key Description

name String Element type name of the node. If the element belongs to a namespace and the namespace was declared at the time the NodeIterator was constructed, name will have the prefix declared for that namespace. If the namespace is not declared, name will use prefix that occurs in the XML.

node com.wm.lang.xml.Node XML node identified by the input criteria used to originally generate the NodeIterator.

It is possible that all calls to getNextNode on a given NodeIterator will yield the same document instance, where the values of the instance’s entries vary. For this reason, applications should assume that each call to getNextNode invalidates the document returned by the previous call. This approach maximizes the speed of the server and minimizes the use of resources.



pub.web:getNodeIteratorWmPublic. Deprecated—Use pub.xml:getXMLNodeIterator. Creates and returns a NodeIterator.

A NodeIterator iterates over the element node descendants of a given node and returns the element nodes that satisfy the indicated criteria. The client application or flow service uses the service pub.web:getNextNode to get each node in turn. NodeIterators can only be created for XML nodes (not for HTML nodes).

pub.web:getNodeIterator is useful for loading and parsing XML documents on demand. Large or slow documents need only be loaded as far as needed to get the desired data. NodeIterators are also useful for providing service as the pertinent information in the document arrives rather than first waiting for the entire document to load. This service is primarily intended to deal with large documents or documents that arrive slowly.

NodeIterator provides a moving-window mode, in which the only node that is resident in memory is the last node returned by pub.web:getNextNode. In this mode, when pub.web:getNextNode is called, all nodes preceding the newly returned node become invalid, including all nodes previously returned by pub.web:getNextNode. The client must fully complete processing preceding nodes before advancing the window by calling pub.web:getNextNode again. In moving-window mode, the document consumes at least enough memory to hold the most recently returned node.

Moving-window mode allows the server to process multi-megabyte XML documents using very little memory. Moving-window mode may only be used on a node that represents an entire XML document and not on any descendant node.

Input Parameters

node com.wm.lang.xml.Node XML node for which you want to produce a NodeIterator. The node can represent either an XML document or an element of an XML document; however, if the NodeIterator will be used in moving-window mode, a whole XML document must be used. This is because moving window mode is only meaningful for managing the loading process of a document, and to operate on a node is to have already loaded the node.


pub.web:getNodeIterator

Output Parameters

criteria String List Optional. Pattern strings identifying the nodes that the iterator is to return. A pattern string may take either the form <localName> or the form <prefix>:<localName>.

When a pattern takes the first form, it identifies an element whose local name is <localName> and that belongs to the default XML namespace. When a pattern takes the second form, it identifies an element whose local name is <localName> and whose XML namespace is given by the prefix <prefix>. If the input parameter nsDecls declares this prefix, the namespace URI of the element must match the URI declared for the prefix. If the prefix is not declared in nsDecls, the prefix is matched against prefixes found in the XML.

<prefix> and <localName> can each optionally take the value “*” (asterisk) to match any namespace or local name. A “*” prefix also matches elements residing in the default namespace.

If you do not specify criteria, all element node children of the root element are returned.

nsDecls Document Optional. Namespaces associated with any namespace prefixes used in criteria. Each entry in nsDecls represents a namespace prefix/URI pair, where a key name represents a prefix and the value of the key specifies the namespace URI.


movingWindow String Optional. Flag indicating whether the NodeIterator is to iterate using a moving window, as described above. In moving-window mode, the entire document preceding the node most recently returned by getNodeIterator is discarded. Subsequent attempts to return preceding portions of the document will return either the repeating text *PURGED* or the proper data, depending on whether the data falls within an area that the server was able to discard. When iterating with a moving window, the current node should be queried and completely examined prior to requesting the next node.

Set to... To...

true To use the NodeIterator in moving-window mode.

false Default. To use the NodeIterator in normal mode.

iterator com.wm.app.b2b.util.NodeIterator A NodeIterator for use with the service pub.web:getNextNode.



pub.web:loadDocumentWmPublic. Deprecated—Use pub.xml:loadXMLNode. Retrieves an XML or HTML document via HTTP or HTTPS, parses it, and returns an XML node.

Input Parameters

url String The URL of the document you want to load. This string must begin with http: or https:. For example:

http://www.rubicon.com/orders/orders.html

—OR—https://localhost:5555/WmPublic/index.html

method String Flag indicating the HTTP method you want loadDocument to use to retrieve the requested resource. Set method to get or post.

auth Document Optional. Authentication and authorization information that loadDocument will use if the requested resource is protected.

Key Description

type String Type of authentication loadDocument will use to submit this request. If you are accessing a protected resource, set auth to Basic.

user String User name that loadDocument will submit if the requested resource is protected.


data Document Optional. The data that you want loadDocument to submit with the request. Specify data using one or more of the following elements.

Key Description

args Document The name=value pairs that loadDocument is to submit to the resource in url.

You can use args to submit data via either the POST or GET method.

To specify data using args, create one element for each name=value pair that you want to submit, where the key represents the name portion of the pair and the value represents the value portion of the pair.


pub.web:loadDocument

Note that when you use args, loadDocument will automatically:



Prefix the entire query string with the “?” character if it submits the data in args via a GET. You do not need to include this character in args.

When you submit data using the args variable, the Integration Server automatically sets the value of the Content-Type header to application/x-www-form-urlencoded. If you want to explicitly specify a different Content-Type, you must submit your data using the string or bytes variable.

table String Table Specifies data that loadDocument will use to construct a query string to submit to the resource specified in url.


To specify data using table, create one row for each value that you want to submit, where:

The contents of column 0 represent the name portion of the pair (leave this column null to submit an unnamed value, and…

The contents of column 1 represent the value portion of the pair.

When you submit data using the table variable, the Integration Server automatically sets the value of the Content-Type header to application/x-www-form-urlencoded. If you want to explicitly specify a different Content-Type, you must submit your data using the string or bytes variable.



Note that when you use table, loadDocument will automatically:




string String Text that you want loadDocument to submit to the resource in url.

You can use string to submit data via either the POST or GET method.

If you use string to specify your data, make sure that you specify the string exactly as you want it presented in the HTTP request. (If you are using the GET method, make sure you URL-encode the contents of string). When performing a POST the string is submitted to the resource as the body of the document.

bytes byte[ ] Data that loadDocument is to submit to the resource in url. You can use bytes only to submit data via the POST method.

Note: When you use bytes and another element (args, table, or string) to submit data with loadDocument, the service appends the data from the args, table, or string element to url. The service appends args to url first, table second, and string last. The service encodes the data from the bytes element in the body of the post.

stream java.io.InputStream Data that loadXMLNode is to submit to the resource in url. You can use stream only to submit data via the POST method.

Note: When you use stream and another element (args, table, or string) to submit data with loadXMLNode, the service appends the data from the args, table, or string element to url. The service appends args to url first, table second, and string last. The service encodes the data from the stream element in the body of the post. If stream is specified, bytes is ignored.

encoding String Name of a registered IANA character set.


pub.web:loadDocument

headers Document Optional. Fields that you want to explicitly override in the HTTP request header issued by loadDocument.

Specify one element for each header field that you want to set, where the key represents the name of the header field and the value represents the value of that header field.

If headers is not set, loadDocument uses its default header values.

encoding String Character set in which the returned document is encoded. The parser requires this value in order to interpret a document correctly.

Set to... To...

autoDetect Determine the document’s character set based on document type, where:

ISO-8859-1 is used for HTML.

UTF-8 is used for XML.

The name of a registered IANA character set

Decode the document using that character set (for example, ISO-8859-1).

If you do not specify an encoding value, loadDocument decodes the returned document using the following defaults:

If the document is... It is decoded using...

HTML ISO-8859-1

XML UTF-8

expandDTD String Flag indicating whether or not loadDocument is to process references to parameter entities in the returned document’s DTD.

Set to... To...

true Expand references to parameter entities to their full definition.

false Default. Ignore references to parameter entities.

isXML String Flag indicating whether the returned document is XML or HTML. loadDocument must know this in order to parse a document correctly.

Set to... To...

autoDetect Default. Parse the document based on its type. When you use this option, loadDocument senses the document’s type based on its <!DOCTYPE…> or <?XML…> tag. If it cannot determine a document’s type, it parses it as HTML.



Output Parameters

Usage Notes

If pub.web:loadDocument does not receive a response within the timeout period specified in the server’s watt.net.timeout parameter, it will throw an exception. For information about the watt.net.timeout parameter, see the webMethods Integration Server Administrator’s Guide.

true Parse the document as XML.

false Parse the document as HTML.

loadAs String Flag that specifies the form in which you want loadDocument to make the returned document available to subsequent services.

Set to... To...

bytes Make the document available as a byte array.

Use this option if the document will be used as input to a service that operates on whole documents (for example, pub.web:queryDocument or pub.xml:queryXMLNode).

stream Make the document available as an InputStream.

Use this option if the document will be used as input to a service that can process a document incrementally, for example, pub.web:getNodeIterator (deprecated) or Usage Notes.

failOnHTTPError String Determines whether loadDocument will fail (throw an exception) if the requested URL is not loaded correctly based on an HTTP status code. This parameter allows for customized error handling of the load failure.

Set to... To...

true Throw a service exception if the URL is not loaded as indicated by an HTTP status code between 400 and 599, inclusive.

false Default. Ignore HTTP errors. If there is an error, the HTML page returned by the web server will be sent to the parser.

node com.wm.lang.xml.Node XML node representing the returned HTML or XML document.


pub.web:makeArrays

pub.web:makeArraysWmPublic. Deprecated—Produces a list of the repeating elements in an XML document based on the document’s DTD.

This list can be used as input to the arrays parameter in pub.web:documentToRecord.

Input Parameters

Output Parameters

pub.web:queryDocumentWmPublic. Deprecated—Use pub.xml:queryXMLNode. Queries an XML node.

Input Parameters

node com.wm.lang.xml.Node XML node for which you want to generate a String List. An XML node can be produced by pub.web:loadDocument, pub.web:stringToDocument, or an XML content handler.

arrays String List Names of each repeating element in node. This variable will be null if the DTD for node cannot be found or if there are no DTD references in node.

node com.wm.lang.xml.Node XML node that you want to query. An XML node can be produced by pub.web:loadDocument, pub.web:stringToDocument, or an XML content handler.

nsDecls Document Optional. Namespaces associated with any namespace prefixes used to specify elements in fields/query. Each entry in nsDecls represents a namespace prefix/URI pair, where a key name represents a prefix and the value of the key specifies the namespace URI.


fields Document List Optional. Parameters describing how data is to be extracted from node. Each document in the list contains parameters for a single query, as follows:

Key Description

name String Name to assign to resulting value.



Output Parameters

Document Results from the queries specified in fields. This service returns one element for each query specified in fields. The specific names and types of the returned elements is determined by the fields/name and field/resultType parameters of the individual queries.

Usage Notes

The fields parameter specifies how data is extracted from the node to produce an output variable. This output variable is called a “binding,” because the fields parameter binds a certain part of the document to a particular output variable. The service must include at least one entry in fields. The result of each query you specify in fields is returned in a variable whose name and type you specify.

resultType String Type of value that the query is to yield. Valid values are Object, Object[ ], Object[ ][ ], Record, Record[ ], String, String[ ], and String[ ][ ].

query String Query identifying the data to be extracted from node.

queryType String Query language in which query is expressed. Valid values are WQL and XQL.

onnull String Code indicating what you want queryDocument to do when the result is null. Set to one of the following:


continue All result values are acceptable for this query (including null).

fail The service should fail if the result of this query is null and continue in all other cases.

succeed The service should continue if the result of this query is null and fail in all other cases.

fields Document List Parameters that support recursive execution of bindings. Each fields list defines bindings for one level of the output with the top level being the pipeline and the first level down being contents of a document or document list in the pipeline.


pub.web:recordToDocument

pub.web:recordToDocumentWmPublic. Deprecated—Use pub.xml:documentToXMLString. Converts a document (IData object) to an XML String.

This service recurses through a given document, building an XML representation of the elements within it. The service turns key names into XML elements and key values into the contents of those elements.

Note that key names that start with the attribute prefix (which, in this example, is the “@” character) are turned into attributes of the elements in which they occur. For example, the @type key in the acctNum element is converted to the type=platinum attribute of the <acctNum> element in the resulting XML String.

Also note that the *body key is used to represent the value of a simple element that contains both a text value and an attribute. See the acctNum and phoneNum keys for an example of this kind of element.

This service would convert this document (IData)... To an XML document that looks like this...

<?xml version="1.0" ?><AcctInfo> <name>Midwest Extreme Sports</name> <rep>Laura M. Sanchez</rep> <acctNum type=platinum>G97041A</acctNum> <phoneNum cc=011>216-741-7566</phoneNum> <address county=USA> <street1>10211 Brook Road</street1> <city>Cleveland</city> <state>OH</state> <postalCode>22130</postalCode> </address> <serialNum>19970523A</serialNum> <serialNum>20001106G</serialNum> <serialNum>20010404K</serialNum></AcctInfo>



Input Parameters

attrPrefix String Optional. Prefix that designates keys containing attributes. The default prefix is “@”.

For example, if you set attrPrefix to ATT_ and boundNode contained the following element:

recordToDocument would convert the ATT_currency key to the attribute, currency=dollars, in the <tx> element as shown below:

<tx currency=dollars> <acct>cash</acct> <amt>120.00</amt></tx>

boundNode Document Document (IData object) to be converted to XML. Note that if you want to produce a valid XML document (one with a single root node), boundNode must contain only one top-level document (that is, a single IData object). The name of that document will serve as the name of the XML document’s root element.

For example, boundNode shown in the description of this service contains one top-level document named AcctInfo, which would result in one root element named <AcctInfo> in the resulting XML String.

If you needed to produce an XML fragment (for example, a loose collection of elements that are not encompassed within a single root element), boundNode can contain multiple top-level elements. To produce this type of output, you must also set the addHeader and enforceLegalXML parameters to false.

nsDecls Document Optional. Namespaces associated with any namespace prefixes that are used in the key names in boundNode. Each entry in nsDecls represents a namespace prefix/URI pair, where a key name represents a prefix and the value of the key specifies the namespace URI.




addHeader String Optional. Flag indicating whether the header element:<?xml version=”1.0”?>

is to be included in the resulting XML String.

Set to... To...

true Default. Include the header.

false Omit the header. (You would omit the header to generate an XML fragment or to insert a custom header.)

encode String Optional. Flag indicating whether to HTML-encode the data.

Set to... To...

true HTML-encode the data.

false Default. Do not HTML-encode the data.

recordName String Optional. Fully qualified name of the document type that describes the structure and format of the output document (for example, examples.rtd:exampleRecord1).

This parameter can be used to ensure that the output includes elements that might not be present in boundNode at run time. It can also be used to describe the order in which elements are to appear in the resulting XML String.

generateRequiredTags String Optional. Flag indicating whether empty tags are to be included in the output document if a mandatory element appears in the document type specified in recordName but does not appear in boundNode.

Set to... To...

true Include mandatory elements if they are not present in boundNode.

false Default. Omit mandatory elements if they are not present in boundNode.

enforceLegalXML String Optional. Flag indicating whether the service throws an exception when boundNode contains multiple root elements or illegal XML tag names.

Set to... To...

true Throw an exception if boundNode produces an XML String containing multiple root elements and/or illegal XML tag names.

false Default. Allow the XML String to contain multiple root elements and/or illegal XML tag names. You would use this setting to create an XML fragment composed of multiple elements that were not all enclosed within a root element.



Output Parameters

dtdHeaderInfo Document Optional. Contents of the DOCTYPE header to be inserted into the XML String. (You can retrieve this information from an incoming document using pub.web:getDocumentType.) Set the following elements in dtdHeaderInfo.

Key Description

systemID String Optional. System identifier for the DTD, if any.

publicID String Optional. Public identifier for the DTD, if any.

rootNSPrefix String Optional. Namespace prefix of the rootLocalName, if any.

rootLocalName String Optional. Local name (excluding the namespace prefix) of the root element.

bufferSize String Optional. Initial size (in bytes) of the String buffer that recordToDocument uses to assemble the output XML String. If the String buffer fills up before recordToDocument is finished generating the XML String, it reallocates the buffer, expanding it by this amount each time the buffer becomes full.

If you do not set bufferSize, recordToDocument looks to see whether a default buffer size is specified in the following parameter on the server:

watt.server.recordToDocument.bufferSize

If so, it uses this value to allocate the String buffer. If this parameter is not set, recordToDocument uses a default buffer size of 4096 bytes.

For best performance, you should always set bufferSize to a value that closely matches the size of the XML String that you expect recordToDocument to produce. This practice will spare the server from having to enlarge the buffer repeatedly if the XML String is many times larger than the default buffer or if you arbitrarily set bufferSize to a value that is too small.

Setting bufferSize to an appropriately sized value will also prevent your service from unnecessarily consuming more memory than it needs if the resulting XML String is much smaller than the default buffer size or if you arbitrarily set bufferSize to a value that is too large.

xmldata String XML document produced from boundNode.



Usage Notes

If you are building an IData that will be converted to an XML String, keep the following points in mind:

If you want to generate a simple element that contains only a character value, represent it with a String element in boundNode as follows:

If you want to generate an element that contains children, represent with an IData in boundNode, as follows:

To produce attributes, put the attribute values in keys whose name starts with the character(s) specified in attrPrefix. For example, if you use the default attrPrefix, the names of all keys containing attributes (and only those keys containing attributes) must start with the @ character (for example, @type, @xmlns).

Also, when you include attributes, make sure that keys representing attributes are direct children of the elements in which they are to be applied. For example, if you want to include an xmlns attribute to the <AcctInfo> element in the example shown in this service’s description, you must create a String element named @xmlns in the AcctInfo element within boundNode.

If you want to generate a simple element that contains a character value and one or more attributes, you must represent it as an IData that has one key for each attribute and a key named *body that contains element’s value. For example, if you wanted to produce the following element: <phoneNum cc=011>216-741-7566</phoneNum>

You would include the following IData in boundNode:

To include namespaces, make sure you do the following:

Include the appropriate namespace prefix in the key names in boundNode. For example, to produce an element called acctNum that belongs to a namespace that is represented by the “GSX” prefix, you would include a key named GSX:acctNum in boundNode.

Define the URIs for the prefixes that appear in boundNode. You can do this through nsDecls or by including an @xmlns key in the element where you want the xmlns attribute to be inserted. See the nsDecls description above for more information about declaring namespaces.



pub.web:str ingToDocumentWmPublic. Deprecated—Use pub.xml:xmlStringToXMLNode. Converts an XML document (represented as a String, byte[ ], or InputStream) to an XML node.

An XML node is a special representation of an XML document that can be consumed by the Integration Server. Most webMethods services that operate on XML documents require an XML node as input.

Input Parameters

Output Parameters

xmldata String Optional. String containing the XML document to convert to an XML node.

$filedata byte[ ] Optional. Byte array containing the XML document to convert to an XML node.

$filestream java.io.InputStream Optional. InputStream containing the XML document to convert to an XML node.

Note: Specify only one of the preceding parameters.

encoding String Optional. Character encoding in which text is represented. Specify UTF-8 for XML files and ISO-8859-1 for HTML files. To have stringToDocument attempt to detect the type of encoding, specify autoDetect (the default, if encoding is not specified).

expandDTD String Optional. Flag indicating whether references to parameter entities in the XML document’s DTD are to be processed.

Set to... To...



isXML String Optional. Flag indicating whether the input document is XML or HTML. (stringToDocument must know this so it that it can parse the document correctly.)

Set to... To...

autoDetect Default. Parse the document based on its type. When you use this option, stringToDocument detects the document’s type based on its <!DOCTYPE…> or <?XML…> tag. If it cannot determine a document’s type, it parses it as HTML.



node com.wm.lang.xml.Node XML node representation of the XML document in xmlData. This object can be used as input to webMethods services that consume XML nodes.


C H A P T E R36
XML Folder
You use the elements in the xml folder to perform operations on XML documents.


C H A P T E R 3 6 X M L F o l d e r


pub.xml:documentToXMLStr ingWmPublic. Converts a document (IData object) to an XML string.

This service recurses through a given document, building an XML representation from the elements within it. Key names are turned into XML elements, and the key values are turned into the contents of those elements.


pub.xml:documentToXMLString WmPublic. Converts a document (IData object) to an XML string.

pub.xml:freeXMLNode WmPublic. Frees the resources allocated to a given XML node.

pub.xml:getNextXMLNode WmPublic. Gets the next XML node from a NodeIterator.

pub.xml:getXMLNodeIterator WmPublic. Creates and returns a NodeIterator.

pub.xml:getXMLNodeType WmPublic. Returns information about an XML node.

pub.xml:loadXMLNode WmPublic. Retrieves an XML document via HTTP or HTTPS, parses it, and produces an XML node.

pub.xml:queryXMLNode WmPublic. Queries an XML node.

pub.xml:xmlNodeToDocument WmPublic. Converts an XML node to a document (an IData object).

pub.xml:xmlStringToXMLNode WmPublic. Converts an XML document (represented as a String, byte[ ], or InputStream) to an XML node.


pub.xml:documentToXMLString

Note that:

Key names that start with the attribute prefix (which, in this example, is the “@” character) are turned into attributes of the elements in which they occur. For example, the @type key in the acctNum element is converted to the type=platinum attribute of the <acctNum> element in the resulting XML String.

Also note that the *body key is used to represent the value of a simple element that contains both a text value and an attribute. See the acctNum and phoneNum keys for an example of this kind of element.

Fields that are not String or Document based (for example, Floats or Integers) are converted to XML values using the underlying object’s toString method.

This service would convert this document (IData object).... To an XML document that looks like this...

<?xml version="1.0" ?><AcctInfo> <name>Midwest Extreme Sports</name> <rep>Laura M. Sanchez</rep> <acctNum type=platinum>G97041A</acctNum> <phoneNum cc=011>216-741-7566</phoneNum> <address country=USA> <street1>10211 Brook Road</street1> <city>Cleveland</city> <state>OH</state> <postalCode>22130</postalCode> </address> <serialNum>19970523A</serialNum> <serialNum>20001106G</serialNum> <serialNum>20010404K</serialNum></AcctInfo>



Input Parameters

attrPrefix String Optional. Prefix that designates keys containing attributes. The default prefix is “@”.

For example, if you set attrPrefix to ATT_ and document contained the following element:

documentToXMLString would convert the ATT_currency key to the attribute, currency=dollars, in the <tx> element as shown below:


document Document IData object that is to be converted to XML. Note that if you want to produce a valid XML document (one with a single root node), document must contain only one top-level IData object (that is, a single document). The name of that document will serve as the name of the XML document’s root element.

For example, document shown in the example in this service’s description contains one top-level document named AcctInfo, which would result in one root element named <AcctInfo> in the resulting XML String.

If you needed to produce an XML fragment (for example, a loose collection of elements that are not encompassed within a single root element) then document can contain multiple top-level elements. To produce this type of output, you must also set the addHeader and enforceLegalXML parameters to false.

nsDecls Document Optional. Namespaces associated with any namespace prefixes that are used in the key names in document. Each entry in nsDecls represents a namespace prefix/URI pair, where a key name represents a prefix and the value of the key specifies the namespace URI.




For each prefix specified in nsDecls, documentToXMLString generates an xmlns attribute and inserts it into the top-most element of the resulting XML String. For example, if nsDecls had the two keys shown above, documentToXMLString would insert the following attributes into the root element of the XML String:

xmlns:gsx="http://www.gsx.com"xmlns:TxMon="http:www.acrtrak/txMonitor"

Note: You can also include a namespace declaration by including an @xmlns key in document (if you weren’t using the @ character to designate attributes, use the correct attribute prefix in your code). The advantage of this approach over nsDecls is that it lets you specify the point where you want the xmlns attribute to be inserted.

addHeader String Optional. Flag specifying whether the header element: <?xml version=”1.0”?>

is to be included in the resulting XML String.

Set to... To...

true Default. Include the header.

false Omit the header. (You would omit the header to generate an XML fragment or to insert a custom header.)

encode String Optional. Flag indicating whether to HTML-encode the data.

Set to... To...

true HTML-encode the data.

false Default. Do not HTML-encode the data.

documentTypeName String Optional. Fully qualified name of the document type that describes the structure and format of the output document (for example, examples.rtd:exampleRecord1).

You can use this parameter to ensure that the output includes elements that might not be present in document at run time, or to describe the order in which elements are to appear in the resulting XML String.

generateRequiredTags String Optional. Flag indicating whether empty tags are to be included in the output document if a mandatory element appears in the document type specified in documentTypeName but does not appear in document.

Set to... To...

true Include mandatory elements if they are not present in document.

false Default. Omit mandatory elements if they are not present in document.



enforceLegalXML String Optional. Flag indicating whether the service throws an exception when document contains multiple root elements or illegal XML tag names.

Set to... To...

true Throw an exception if document would produce an XML String containing multiple root elements and/or illegal XML tag names.

false Default. Allow the resulting XML String to contain multiple root elements and/or illegal XML tag names. You would use this setting, for example, to create an XML fragment composed of multiple elements that were not all enclosed within a root element.

dtdHeaderInfo Document Optional. Contents of the DOCTYPE header to be inserted into the XML String. (You can retrieve this information from an incoming document using pub.xml:getXMLNodeType.)

Key Description

systemID String Optional. System identifier for the DTD, if any.

publicID String Optional. Public identifier for the DTD, if any.

rootNSPrefix String Optional. Namespace prefix of the rootLocalName, if any.

rootLocalName String Optional. Local name (excluding the namespace prefix) of the root element.



Output Parameters

Usage Notes

If you are building an IData that will be converted to an XML String, keep the following points in mind:

If you want to generate a simple element that contains only a character value, represent it with a String element in document as shown in the following:

If you want to generate an element that contains children, represent with an IData in document as shown in the following.

To produce attributes, put the attribute values in keys whose name starts with the character(s) specified in attrPrefix. For example, if you use the default attrPrefix, the names of all keys

bufferSize String Optional. Initial size (in bytes) of the String buffer that documentToXMLString uses to assemble the output XML String. If the String buffer fills up before documentToXMLString is finished generating the XML String, it reallocates the buffer, expanding it by this amount each time the buffer becomes full.

If you do not set bufferSize, documentToXMLString looks to see whether a default buffer size is specified in the following parameter on the server:

watt.server.recordToDocument.bufferSize

If so, it uses this value to allocate the String buffer. If this parameter is not set, documentToXMLString uses a default buffer size of 4096 bytes.

For best performance, you should always set bufferSize to a value that closely matches the size of the XML String that you expect documentToXMLString to produce. This practice will spare the server from having to enlarge the buffer repeatedly if the XML String is many times larger than the default buffer or if you arbitrarily set bufferSize to a value that is too small.

Setting bufferSize to an appropriately sized value will also prevent your service from unnecessarily consuming more memory than it needs if the XML String is much smaller than the default buffer size or if you arbitrarily set bufferSize to a value that is too large.

xmldata String XML String produced from document.



containing attributes (and only those keys containing attributes) must start with the @ character (for example, @type, @xmlns).

Also, when you include attributes, make sure that keys representing attributes are direct children of the elements in which they are to be applied. For example, if you want to include an xmlns attribute in the <AcctInfo> element in the example shown in the description of this service, you must create a String field named @xmlns in the AcctInfo field within document.

If you want to generate a simple element that contains a character value and one or more attributes, you must represent it as an IData that has one key for each attribute and a key named *body that contains element’s value. For example, if you wanted to produce the following element: <phoneNum cc=011>216-741-7566</phoneNum>

You would include the following in document:

To include namespaces, make sure you do the following:

Include the appropriate namespace prefix in the key names in document. For example, to produce an element called acctNum that belongs to a namespace that is represented by the “GSX” prefix, you would include a key named GSX:acctNum in document.

Define the URIs for the prefixes that appear in document. You can do this through nsDecls or by including an @xmlns key in the element where you want the xmlns attribute to be inserted. See the nsDecls description above for more information about declaring namespaces.

pub.xml:freeXMLNodeWmPublic. Frees the resources allocated to a given XML node.

You can optionally call this service when you are using a NodeIterator to iterate over an XML node and you decide to stop processing the node before reaching the end. By explicitly calling pub.xml:freeXMLNode, you immediately free the resources associated with the node instead of waiting for Java garbage collection to do this. Although it is not mandatory to call this service when you finish processing an XML node with a NodeIterator, doing so can boost server performance. Note that after you have freed an XML node using this service, the node becomes unstable and should not be used by any subsequent processes.

Input Parameters

Output Parameters

None.

rootNode com.wm.lang.xml.Document XML node whose resources you want to release.


pub.xml:getNextXMLNode

pub.xml:getNextXMLNodeWmPublic. Gets the next XML node from a NodeIterator.

Input Parameters

Output Parameters

Usage Notes

A NodeIterator is acquired via the service Usage Notes. The output of that service is a document (IData object) containing the element type name of the node and the node itself. The instance of this document is only valid until the next getNextXMLNode call on the same NodeIterator, because getNextXMLNode uses the same document object for each call.

pub.xml:getXMLNodeIteratorWmPublic. Creates and returns a NodeIterator.

A NodeIterator iterates over the element node descendants of an XML node and returns the element nodes that satisfy the given criteria. The client application or flow service uses the service pub.xml:getNextXMLNode to get each node in turn. NodeIterators can only be created for XML nodes (not for HTML nodes).

getXMLNodeIterator is useful for loading and parsing documents on demand. Large or slow documents need only be loaded as far as needed to get the desired data. NodeIterators are also useful for providing service

iterator com.wm.app.b2b.util.NodeIterator NodeIterator from which to retrieve the next node.

next Document Conditional. The requested node. Will be null when the NodeIterator has no more nodes to return. Otherwise, next will contain the following:

Key Description

name String Element type name of the node. If the element belongs to a namespace and the namespace was declared at the time the NodeIterator was constructed, name will have the prefix declared for that namespace. If the namespace is not declared, name will use prefix that occurs in the XML.

node com.wm.lang.xml.Node XML node identified by the input criteria used to originally generate the NodeIterator.

It is possible that all calls to getNextXMLNode on a given NodeIterator will yield the same document instance, where the values of the instance’s entries vary. For this reason, applications should assume that each call to getNextXMLNode invalidates the document returned by the previous call. This approach maximizes the speed of the server and minimizes the use of resources.



as the pertinent information in the document arrives rather than first waiting for the entire document to load. This service is primarily intended to deal with large documents or documents that arrive slowly.

NodeIterator provides a moving-window mode, in which the only node that is resident in memory is the last node returned by pub.xml:getNextXMLNode. In this mode, when pub.xml:getNextXMLNode is called, all nodes preceding the newly returned node become invalid, including all nodes previously returned by pub.xml:getNextXMLNode. The client must fully complete processing preceding nodes before advancing the window by calling pub.xml:getNextXMLNode again. In moving-window mode, the document consumes at least enough memory to hold the most recently returned node.

Moving-window mode allows the server to process multi-megabyte XML documents using very little memory. Moving-window mode may only be used on a node that represents an entire XML document and not on any descendant node.

Input Parameters

node com.wm.lang.xml.Node XML node for which you want to produce a NodeIterator. The node can represent either an XML document or an element of an XML document; however, if the NodeIterator will be used in moving-window mode, a whole XML document must be used. This is because moving window mode is only meaningful for managing the loading process of a document, and to operate on a node is to have already loaded the node.

criteria String List Optional. Pattern strings identifying the nodes that the iterator is to return. A pattern string may take either the form <localName> or the form <prefix>:<localName>.

When a pattern takes the first form, it identifies an element whose local name is <localName> and that belongs to the default XML namespace. When a pattern takes the second form, it identifies an element whose local name is <localName> and whose XML namespace is given by the prefix <prefix>. If the input parameter nsDecls declares this prefix, the namespace URI of the element must match the URI declared for the prefix. If the prefix is not declared in nsDecls, the prefix is matched against prefixes found in the XML.

<prefix> and <localName> can each optionally take the value “*” (asterisk) to match any namespace or local name. A “*” prefix also matches elements residing in the default namespace.

If you do not specify criteria, all element node children of the root element are returned.

nsDecls Document Optional. Namespaces associated with any namespace prefixes used in criteria. Each entry in nsDecls represents a namespace prefix/URI pair, where a key name represents a prefix and the value of the key specifies the namespace URI.


pub.xml:getXMLNodeType

Output Parameters

pub.xml:getXMLNodeTypeWmPublic. Returns information about an XML node.

Input Parameters

Output Parameters


movingWindow String Optional. Flag indicating whether the NodeIterator is to iterate using a moving window, as described above. In moving-window mode, the entire document preceding the node most recently returned by getXMLNodeIterator is discarded. Subsequent attempts to return preceding portions of the document will return either the repeating text *PURGED* or the proper data, depending on whether the data falls within an area that the server was able to discard. When iterating with a moving window, the current node should be queried and completely examined prior to requesting the next node.

Set to... To...

true To use the NodeIterator in moving-window mode.

false Default. To use the NodeIterator in normal mode.

iterator com.wm.app.b2b.util.NodeIterator NodeIterator for use with the service pub.xml:getNextXMLNode.

rootNode com.wm.lang.xml.Document XML node about which you want information.

systemID String Conditional. System identifier, as provided by the DTD associated with rootNode. If rootNode does not have a system identifier, this value is null.

publicID String Conditional. Public identifier, as provided by the DTD associated with rootNode. If rootNode does not have a public identifier, this value is null.

rootNamespace String URI of the XML namespace to which rootNode’s root element belongs.

rootNSPrefix String Conditional. Namespace prefix of root element in rootNode, if any.

rootLocalName String Conditional. Local name (excluding the namespace prefix) of the root element in rootNode, if any.



pub.xml: loadXMLNodeWmPublic. Retrieves an XML document via HTTP or HTTPS, parses it, and produces an XML node.

Input Parameters

url String The URL of the document you want to load. This string must begin with http: or https:. For example:

http://www.rubicon.com/orders/orders.html

—OR—https://localhost:5555/WmPublic/index.html

method String Optional. Flag indicating the HTTP method you want loadXMLNode to use to retrieve the requested resource. Set to get or post.

auth Document Optional. Authentication and authorization information that loadXMLNode will use if the requested resource is protected.

Key Description

type String Type of authentication loadXMLNode will use to submit this request. If you are accessing a protected resource, set to Basic.

user String User name that loadXMLNode will submit if the requested resource is protected.


data Document Optional. The data that you want loadXMLNode to submit with the request. Specify data using one or more of the following elements.

Note: When you use more than one element to submit data, args is appended first, table is appended second, and string is appended last.

Key Description

args Document Optional. Specifies name=value pairs that loadXMLNode is to submit to the resource in url.

You can use args to submit data via either the POST or GET method.

To specify data using args, create one element for each name=value pair that you want to submit, where the key represents the name portion of the pair and the value represents the value portion of the pair.


pub.xml:loadXMLNode

Note that when you use args, loadXMLNode will automatically:



Prefix the entire query string with the “?” character if it submits the data in args via a GET. You do not need to include this character in args.

When you submit data using the args variable, the Integration Server automatically sets the value of the Content-Type header to application/x-www-form-urlencoded. If you want to explicitly specify a different Content-Type, you must submit your data using the string or bytes variable.

table String Table Optional. Specifies data that loadXMLNode will use to construct a query string to submit to the resource specified in url.


To specify data using table, create one row for each value that you want to submit, where:

The contents of column 0 represent the name portion of the pair (leave this column null to submit an unnamed value, and…

The contents of column 1 represent the value portion of the pair.

When you submit data using the table variable, the Integration Server automatically sets the value of the Content-Type header to application/x-www-form-urlencoded. If you want to explicitly specify a different Content-Type, you must submit your data using the string or bytes variable.



Note that when you use table, loadXMLNode will automatically:




string String Optional. Text that you want loadXMLNode to submit to the resource in url.

You can use string to submit data via either the POST or GET method.

If you use string to specify your data, make sure that you specify the string exactly as you want it presented in the HTTP request. (If you are using the GET method, make sure you URL-encode the contents of string). When performing a POST the string is submitted to the resource as the body of the document.

bytes byte[ ] Optional. Data that loadXMLNode is to submit to the resource in url. You can use bytes only to submit data via the POST method.

Note: When you use bytes and another element (args, table, or string) to submit data with loadXMLNode, the service appends the data from the args, table, or string element to url. The service appends args to url first, table second, and string last. The service encodes the data from the bytes element in the body of the post.

stream java.io.InputStream Optional. Data that loadXMLNode is to submit to the resource in url. You can use stream only to submit data via the POST method.

Note: When you use stream and another element (args, table, or string) to submit data with loadXMLNode, the service appends the data from the args, table, or string element to url. The service appends args to url first, table second, and string last. The service encodes the data from the stream element in the body of the post. If stream is specified, bytes is ignored.

encoding String Optional. Name of a registered IANA character set.


pub.xml:loadXMLNode

headers Document Optional. Fields that you want to explicitly override in the HTTP request header issued by loadXMLNode.

Specify one element for each header field that you want to set, where the element’s name represents the name of the header field, and the element’s value represents the value of that header field.

If headers is not set, loadXMLNode will use its default header values.

encoding String Optional. Character set in which the returned document is encoded. The parser requires this value in order to interpret a document correctly.

Set to... To...

autoDetect Determine the document’s character set based on document type, where:

ISO-8859-1 is used for HTML.

UTF-8 is used for XML.

The name of a registered IANA character set

Decode the document using that character set (for example, ISO-8859-1).

If you do not specify an encoding value, loadXMLNode decodes the returned document using the following defaults:

If the document is... It is decoded using...

HTML ISO-8859-1

XML UTF-8

expandDTD String Optional. Flag indicating whether or not loadXMLNode is to process references to parameter entities in the returned document’s DTD.

Set to... To...



isXML String Optional. Flag indicating whether the returned document is XML or HTML. loadXMLNode must know this in order to parse a document correctly.

Set to... To...

autoDetect Default. Parse the document based on its type. When you use this option, loadXMLNode senses the document’s type based on its <!DOCTYPE…> or <?XML…> tag. If it cannot determine a document’s type, it parses it as HTML.




Output Parameters

Usage Notes

If loadXMLNode does not receive a response within the timeout period specified in the server’s watt.net.timeout parameter, it will throw an exception. For information about the watt.net.timeout parameter, see the webMethods Integration Server Administrator’s Guide.


loadAs String Optional. Flag that specifies the form in which you want loadXMLNode to make the parsed document available to subsequent services.

Set to... To...

bytes Default. Make the document available as a byte array.

Use this option if the document will be used as input to a service that operates on whole documents (for example, pub.xml:queryXMLNode).

stream Make the document available as an InputStream.

Use this option if the document will be used as input to a service that can process a document incrementally (for example, pub.xml:getXMLNodeIterator).

failOnHTTPError String Optional. Determines whether loadXMLNode will fail (throw an exception) if the requested URL is not loaded correctly based on an HTTP status code. This parameter allows for customized error handling of the load failure.

Set to... To...

true Throw a service exception if the URL is not loaded as indicated by an HTTP status code between 400 and 599, inclusive.

false Default. Ignore HTTP errors. If there is an error, the HTML page returned by the web server will be sent to the parser.

node com.wm.lang.xml.Node XML node representing the returned HTML or XML document.


pub.xml:queryXMLNode

pub.xml:queryXMLNodeWmPublic. Queries an XML node.

The fields parameter specifies how data is extracted from the node to produce an output variable. This output variable is called a “binding,” because the fields parameter binds a certain part of the document to a particular output variable. At run time, this service must include at least one fields entry. The service must include at least one entry in fields. The result of each query you specify in fields is returned in a variable whose name and type you specify.

Input Parameters

node com.wm.lang.xml.Node XML node that you want to query. An XML node can be produced by pub.xml:loadXMLNode, pub.xml:xmlStringToXMLNode or an XML content handler.

nsDecls Document Optional. Namespaces associated with any namespace prefixes used element to specify elements in fields/query. Each entry in nsDecls represents a namespace prefix/URI pair, where a key name represents a prefix and the value of the key specifies the namespace URI.


fields Document List Optional. Parameters describing how data is to be extracted from node. Each document in the list contains parameters for a single query, as follows:

Key Description

name String Name to assign to resulting value.

resultType String Object type that the query is to yield. The following shows the allowed values for resultType. Because this parameter is typically set through the Variables tab in Developer, the setting you would select in Developer is also shown here.

Underlying Value Corresponding Selection in Developer

Object Object

Object[] Object List

Record Document

Record[] Document List

String String

String[] String List



Output Parameters

Document Results from the queries specified in fields. This service returns one element for each query specified in fields. The specific names and types of the returned elements are determined by the fields/name and field/resultType parameters of the individual queries.

String[][] String Table

query String Query identifying the data to be extracted from node.

queryType String Query language in which query is expressed. Valid values are WQL and XQL.

onnull String Code indicating what you want queryXMLNode to do when the result is null. Set to one of the following:


continue All result values are acceptable for this query (including null).

fail The service should fail if the result of this query is null and continue in all other cases.

succeed The service should continue if the result of this query is null and fail in all other cases.

fields Document List Parameters that support recursive execution of bindings. Each fields list defines bindings for one level of the output with the top level being the pipeline and the first level down being contents of a document or document list in the pipeline.


pub.xml:xmlNodeToDocument

pub.xml:xmlNodeToDocumentWmPublic. Converts an XML node to a document (an IData object).

This service transforms each element and attribute in the XML node to an element in an IData object. For example:

Note that:

The XML version attribute is converted to an element named @version.

The resulting document is given the same name as the XML document’s root element (AcctInfo in the example above) and is a child of the document variable that this service returns.

Simple elements (such as <name> and <rep> in the example above) are converted to String elements.

Complex elements (that is, elements with children, such as <address> in the example above) and simple elements that have attributes (such as <acctNum> and <phoneNum>) are converted to documents (IData objects). Note that keys derived from attributes are prefixed with a “@” character to distinguish them from keys derived from elements. Also note that when a simple element has an attribute, its value is placed in an element named *body.

Repeated elements (such as <serialNum>) can be collected into arrays using the makeArrays and/or arrays parameters. See makeArrays and arrays below for additional information about producing arrays.

This service would convert this XML document... To an IData that looks like this...

<?xml version="1.0" ?><AcctInfo> <name>Midwest Extreme Sports</name> <rep>Laura M. Sanchez</rep> <acctNum type=platinum>G97041A</acctNum> <phoneNum cc=011>216-741-7566</phoneNum> <address country=USA> <street1>10211 Brook Road</street1> <city>Cleveland</city> <state>OH</state> <postalCode>22130</postalCode> </address> <serialNum>19970523A</serialNum> <serialNum>20001106G</serialNum> <serialNum>20010404K</serialNum></AcctInfo>



Input Parameters

node com.wm.lang.xml.Node XML node that is to be converted to a document (IData object).

attrPrefix String Optional. Prefix that is to be used to designate keys containing attribute values. The default is “@”. For example, if you set attrPrefix to ATT_ and node contained the following element:


xmlNodeToDocument would convert the currency attribute as follows:

arrays String List Optional. Names of elements that are to be generated as arrays, regardless of whether they appear multiple times in node. For example, if arrays contained the following values for the XML document shown in the example in the description for this service:

repaddress

xmlNodeToDocument would generate element rep as a String List and element address as a Document List. You may optionally include namespace prefixes in the element names that you specify in arrays; however, if you do, you must define the namespaces associated with those prefixes in nsDecls.

makeArrays String Optional. Flag indicating whether you want xmlNodeToDocument to automatically create an array for every element that appears in node more than once.

Set to... To...

true Default. Automatically create arrays for every element that appears more than once in node.

false Create arrays for only those elements specified in arrays or defined as arrays in the document type specified in documentTypeName.

Important! You must set makeArrays to false when using documentTypeName to define the structure of an element. Otherwise, an exception will be thrown at run time.

The currency attribute is prefixed with the characters “ATT_”



collect Document Optional. Elements that are to be placed into a new, named array (that is, a “collection”). Within collect, use key names to specify the names of the elements that are to be included in the collection. Then set the value of each key to specify the name of the collection in which you want that element placed. For example, if you wanted to place the <name> and <rep> elements in an array called originator, you would set collect as follows:

Key Value

name originator

rep originator

If the set of elements in a collection are all simple elements, a String List is produced. However, if the set is made up of complex elements, or a combination of simple and complex elements, a Document List is produced. When this is the case, each member of the array will include a child element called *name that contains the name of the element from which that member was derived.

You may optionally include namespace prefixes in the element names that you specify in collect; however, if you do, you must define the namespaces associated with those prefixes in nsDecls.

Important! You cannot include an element in more than one collection.

nsDecls Document Optional. Namespace prefixes to use for the conversion. This parameter specifies the prefixes that will be used when namespace-qualified elements are converted to key names in the resulting IData object. For example, if you want elements belonging to a particular namespace to have the prefix GSX in the resulting IData (for example, GSX:acctNum), you would associate the prefix GSX with that namespace in nsDecls. (This is important because incoming XML documents can use any prefix for a given namespace, but the key names expected by a target service or MAP step on the Integration Server will have a fixed prefix.)

Namespace prefixes in nsDecls also define the prefixes used by the arrays, documents, documentTypeName, and collect parameters.

Each entry in nsDecls represents a namespace prefix/URI pair, where a key name represents a prefix and the value of the key specifies the namespace URI.




documents String List Optional. Names of any simple elements that are to be generated as documents (IData objects) instead of Strings. The document produced for each element specified in documents will have the same name as the source element from which it is derived. It will contain a String element named *body that holds the element’s value.

For example, if documents contained the Strings name and rep and the source document contained the following:

. . .<name>Midwest Extreme Sports</name><rep>Laura M. Sanchez</rep> . . .

xmlNodeToDocument would produce the following:

documentTypeName String Optional. Fully qualified name of the document type that specifies the structure that is to be imposed on the resulting document. You can use this parameter to explicitly specify the order and dimensionality of elements. It is an alternative to using makeArrays and arrays to specify which elements are to be generated as arrays.

For example, if you had the XML document shown in the example in this service’s description, and you wanted the <name> and <rep> elements to be generated as String lists, you would define them as String Lists fields in a document type and then specify that document type in documentTypeName.

Note: The document type specified in documentTypeName does not need to specify every element that will appear in the resulting document. It only needs to specify the elements whose structure you want to explicitly set.

This service always converts XML nodes to String or Document object fields. It does not generate constrained objects (for example, Floats or Integers), even if the fields in the specified document are defined as constrained objects.

Important! When you use documentTypeName, set makeArrays to false and do not set arrays and documents. Otherwise, xmlNodeToDocument will throw an exception at run time.



Output Parameters

Usage Notes

Following are examples of XML documents and the documents (IData objects) that xmlNodeToDocument would produce.

mixedModel String Optional. Flag specifying how mixed-content elements (elements containing both text values and child elements) are to be converted. The following is an example of a mixed-content element:<comment> This job is <status>pending</status>. Estimated completion date is <edc>Feb 14, 2000</edc>.</comment>

Set to... To...

true Place top-level text in an element named *body. This setting would produce the following IData for the <comment> element shown above:

Important! When you set mixedModel to true, you must also use documentTypeName to specify a document type that describes the structure of the IData that you want xmlNodeToDocument to produce. Within the document type, mixed-content elements must be defined as documents that include a String field named *body.

false Omit top-level text and include only the child elements from mixed-content elements. This setting would produce the following IData for the <comment> element shown above:

document Document Document (IData object) representation of the nodes and attributes in node.



XML Document Output from xmlNodeToDocument

<myDoc> <e1>e1Value</e1></myDoc>

<?xml version="1.0" encoding="UTF-8" standalone="no"?><myDoc> <e1>e1Value</e1></myDoc>

<?xml version="1.0" encoding="UTF-8" standalone="no"?><myDoc> <e1 e1Attr="attrValue">e1Value</e1></myDoc>

<?xml version="1.0" encoding="UTF-8" standalone="no"?><myDoc> <e1>e1Value</e1> <e2>e2Value</e2></myDoc>

<?xml version="1.0" encoding="UTF-8" standalone="no"?><myDoc> <e1>e1Value1</e1> <e2>e2Value</e2> <e1>e1Value2</e1></myDoc>




Note: This example assumes that makeArrays is set to true. Note that e1 was created as a document list, which holds both <e1> elements from the XML document.


Note: This example assumes that makeArrays is set to false. Note that only the last <e1> element in the source XML was retained in the resulting document.

<?xml version="1.0" encoding="UTF-8"?><myDoc> <e1 e1Attr="attrValue1">e1Value1</e1> <e2> <e3>e3Value</e3> <e4 e4Attr="attrValue4" e4Attrb="attrValue4b">e4Value </e4> </e2></myDoc>

XML Document Output from xmlNodeToDocument



pub.xml:xmlStr ingToXMLNodeWmPublic. Converts an XML document (represented as a String, byte[ ], or InputStream) to an XML node.

An XML node is a special representation of an XML document that can be consumed by the Integration Server. Most webMethods services that operate on XML documents require an XML node as input.

Input Parameters

Output Parameters

xmldata String Optional. String containing the XML document to convert to an XML node.

$filedata byte[ ] Optional. byte[ ] containing the XML document to convert to an XML node.

$filestream java.io.InputStream Optional. InputStream containing the XML document to convert to an XML node.

Note: Specify only one of the preceding parameters.

encoding String Optional. Character encoding in which text is represented. Specify UTF-8 for XML files and ISO-8859-1 for HTML files. To have the parser attempt to detect the type of encoding, specify autoDetect (the default, if encoding is not specified).

expandDTD String Optional. Flag indicating whether references to parameter entities in the XML document’s DTD are to be processed.

Set to... To...



isXML String Optional. Flag specifying whether the input document is XML or HTML. (xmlStringToXMLNode must know this so that it can parse the document correctly.)

Set to... To...

autoDetect Default. Parse the document based on its type. When you use this option, xmlStringToXMLNode detects the document’s type based on its <!DOCTYPE…> or <?XML…> tag. If it cannot determine a document’s type, it parses it as HTML.



node com.wm.lang.xml.Node XML node representation of the XML document in xmlData. This object can be used as input to webMethods services that consume XML nodes.


Index

Index

Aaccess permissions assigned to built-in services 23accessPoint 422ACLs assigned to built-in services 23activatePackage 212add_publisherAssertions 466addBodyEntry 356addBodyPart 192addComplexTask 302addFloatList 179addFloats 180addHeaderEntry 357adding

body parts to MIME messages 192documents to list 168entries into a data store 376LDAP server entries 156MIME message headers 196numeric values 179, 180, 181strings to list 170

addIntList 180addInts 181addMimeHeader 196addObjects 181addOnetimeTask 304addReleaseRegistryEntry 286addRepeatingTask 305address 423addressLine 423addSubscriber 109addTrailer 359alarm specification 112alarmInfo document type 113appending data to a remote file 51appendToDocumentList 168appendToRecordList 169appendToStringList 170arithmetic services 177ART services 25

assertionStatusItem 424assertionStatusReport 425asynchronous call to a remote server 283asynchronous request/reply

delivering request 257description of 258, 268publishing request 267publishing request to a specific client 257retrieving reply 270

attributesdefinition 158modifying in LDAP entries 164

audit events, logging 133audit log, event logging 133audit specification 113auditInfo document type 114authToken 425

Bbase64Decode 385base64Encode 385binding

entry into an LDAP server 156listing 160output template to Values object 298

bindingDetail 426bindingKey 426bindingTemplate 427bindingTemplates 427businessDetail 427businessDetailExt 428businessEntity 428businessEntityExt 429businessInfo 429businessInfos 430businessKey 430businessList 430businessService 431businessServices 431


I n d e x

byte array from string 393byte[ ], converting to InputStream 153bytesToStream 154bytesToString 385

Ccall 77calling stored procedures 77callStackItem document type 114cancelTask 306canonical document, definition 405canonical keys

creating 404inserting 408retrieving 406

categoryBag 431cd 52cdls 52certificate chain 325certs-only S/MIME Message

creating 340extracting certificates from 344

changeProcessStatus 233changing the working directory 52character sequence, indexing first occurrence 387clearing transactional state 79clearKeyAndChain 325clearPipeline 141clearTransaction 79client certificates 323client services 37close connection 80closeAll 81closeLatch 402closeStore 377closing database connection 80cluster services 61committing changes to a database 81commitTransaction 33complex tasks

adding to scheduler 302updating to scheduler 309

concatenatingarray of strings 389strings 386

connecting to an LDAP server 157connections

closing 158creating 82deleting 329

contact 432contacts 432content type, getting from MIME message 203conventions used in this document 23converting

date formats 65string list to document list 173time formats 65XML nodes to IData objects 529

copyListItem 170correlations, setting up 243CorrelationService specification 231createCertsOnlyData 340createEncryptedData 341createMessageDigest 335createMimeData 198createRegions 484createSignedAndEncryptedData 222, 342createSignedData 223, 343createSoapData 360createXReference 404createXSD 316creating MIME messages 198cross-references

creating 404deleting by object ID 405deleting individual records 406inserting 408

currentDate 69

Ddata

converting 153waiting for delivery 398


Index

data storesadding entries 376closing 377deleting 377inserting entries 380registering 380removing entries 381retrieving values 378unlocking entries 380, 381unregistering 377updating entries 380

database connection, closing 80, 81database services 75databases

clearing transactional state 79closing connections 80, 81committing changes 81creating connections 82deleting rows 84discarding changes 97invoking stored procedures 77querying 96retrieving names of stored procedures 90retrieving tables 93starting a transaction 98

datatypes in XML Schemas 320date/time transformation services 65dateBuild 70dates

converting formats 72formatting 72invalid dates 69returning current 69, 73symbols used for 66time zones 67

dateTimeBuild 71dateTimeFormat 72debug log 141debugging services 139decoding URL-encoded strings 396decrypting

MIME messages 345S/MIME messages 224

default key, associating with invoked services 325delete_binding 467delete_business 467delete_publisherAssertions 468delete_service 469delete_tModel 470deleteAllConnections 329deleteByCID 246deleteByObjectId 405deleteConnection 329deleteCorrelation 243deleteProcess 234deleteReleaseRegistryEntry 287deleteStore 377deleteSubscriber 115deleteXReference 406deleting

cross-reference by object ID 405cross-references 406data stores 377entry from an LDAP server 158files in working directory 53rows from a database 84storage information for processes 234subscribers from subscription list 115

deliver service 254deliverAndWait service 256digital signatures

attaching to MIME messages 343verifying 225, 328, 346

dir 53directory

changing 52looking up entries on LDAP server 162searching for entries 163

disableConnection 27disableListener 28disableListenerNotification 30disableListeners 329disablePackage 213disablePollingNotification 30disableServiceRedir 62disableSessionRedir 62


I n d e x

discard_authToken 470disconnecting from an LDAP server 158discoveryURL 433discoveryURLs 433dispositionReport 433distributeViaFTP 288distributeViaSvcPull 289distributeViaSvcPush 289divideFloats 182divideInts 183divideObjects 183docType_categoryBag 434docType_description 434docType_keyedReference 434docType_name 435document services 101document types

alarmInfo 113audit event information 114callStackItem 114exception information 117gdEndInfo 118gdStartInfo 119portStatusInfo 125ProcessData 232QName 367replicationInfo 126sessionEndInfo 128sessionExpireInfo 128sessionStartInfo 129statInfo 131txEndInfo 132txStartInfo 133

documentationadditional 24conventions used 23feedback 24

documentListToDocument 102documentResolverSpec specification 258documents

adding to list 168constructing from a list of documents 102converting list from string list 173

converting to a String 104converting to XML strings 512delivering 254delivering and waiting for reply 256expanding contents into a list of documents 103processing as part of business process 248publishing 264publishing and waiting for reply 266replacing 172replying to 268resolving status of 258retrieving redelivery count 263waiting for 270

documentToDocumentList 103documentToRecord 486documentToXMLString 512documentToXMLValues 104dynamic text generation 298

Eelements, number of in a list 173email 435enableConnection 27enableListener 29enableListenerNotification 30enablePackage 214enablePollingNotification 31encoding schema, SOAP 356encoding URL strings 396encrypting MIME messages 222, 341ending guaranteed delivery transactions 280entries

adding to LDAP server 156inserting into repository 376looking up on LDAP server 162searching for all matching 163

envelope schema, SOAP 356envelope stream, generating from MIME message 204envelope, for published documents 259errInfo 435error log, exception events 134error notification document type 271error service 271


Index

establishCorrelation 243event handlers 107

alarm specification 112alarmInfo document type 113audit logToFile service 133audit specification 113auditInfo document type 114callStackItem document type 114exception logToFile service 134exception specification 116exceptionInfo document type 117gdEnd specification 117gdEndInfo document type 118gdStart specification 118gdStartInfo document type 119get list of event types 119get list of subscribers 120modify subscriber info 121portStatus specification 124portStatusInfo document type 125reload event manager settings 125replication specification 126replicationInfo document type 126save event manager settings 127sessionEnd specification 127sessionEndInfo document type 128sessionExpire specification 128sessionExpireInfo document type 128sessionStart specification 129sessionStartInfo document type 129stat specification 130statInfo document type 131subscriptions for 109txEnd specification 132txEndInfo document type 132txStart specification 133txStartInfo document type 133unsubscribing from an event 115

events, creating subscriptions for 109exception events, logging 134exception specification 116exceptionInfo document type 117exceptions for retry 147

exceptions, last trapped in a flow 141execSQL 85exitUnableToUnderstand 360expToProperty 235expToVariable 236extracting MIME content 200extracting MIME message headers 202, 205

Ffields, removing from pipeline 141file object, templates 296file services 135files

appending data to 51deleting 53listing 52, 53, 56multiple delete 57multiple get 57multiple transfer 58renaming 59retrieving 54, 136saving pipeline contents 146transferring 58

find_binding 447find_business 448find_businessByCategory 449find_businessByDiscURLs 450find_businessByIdentity 450find_businessByName 451find_businessBytModel 452find_relatedBusinesses 453find_service 454find_serviceByBusKey 455find_serviceByCategory 456find_serviceByName 457find_serviceBytModel 458find_tModel 459find_tModelByCategory 460find_tModelByIdentity 460find_tModelByName 461finding universal names 480findQualifier 435findQualifiers 436


I n d e x

fire-and-forget call 282floating point numbers

adding 179dividing 182multiplying 184subtracting 188

flow services 139forcing a response string 146formatDate 72formatting

array of strings 390number to numeric pattern 390

fragment files, processing 234freeDocument 494freeXMLNode 518fromKey 436FTP

changing directory and listing files 52changing working directory 52client actions 39delete file 53executing non-standard FTP commands 59file transfer 58listing files 53, 56login 55logout 56multiple file delete 57multiple file get 57multiple file transfer 58renaming files 59retrieving files 54session info 60transferring files 58

FTP servers, submitting requests to 37, 40

GgdEnd specification 117gdEndInfo document type 118gdStart specification 118gdStartInfo document type 119generateReplicationEvent 289get (FTP) files 54get_assertionstatusReport 471

get_authToken 472get_bindingDetail 462get_businessDetail 463get_businessDetailExt 464get_publisherAssertions 473get_registeredInfo 474get_serviceDetail 464get_tModelDetail 465getActor 361getAttributeDef 158getBody 361getBodyEntries 362getBodyPartContent 200getBodyPartHeader 202getCanonicalKey 406getCertificateInfo 336getClassDef 159getClusterHosts 63getConnectionStatistics 27getContentType 203getCurrentDate 73getCurrentDateString 73getDocument 363getDocumentType 494getEnvelopeStream 204getEventTypes 119getFile 136getHeader 363getHeaderEntries 364getLastError 141getListItem 171getLocalReleasedList 290getMimeHeader 205getMustUnderstand 365getNativeId 407getNextNode 495getNextXMLNode 519getNodeIterator 496getNumConnections 326, 330getNumParts 206getPIDforCID 247getPrimaryContentType 207getProcInfo 89


Index

getProcs 90getQName 366getRecordListItem 171getRedeliveryCount service 263getRemoteReleasedList 290getRoleInfo 248getServerType 330getSession 143getStatus 280getStringListItem 171getSubContentType 208getSubscribers 120getTableInfo 91getTables 93getTaskIDs 306getTaskInfo 307getTrailer service 367getTransportInfo 143getXMLNodeIterator 519getXMLNodeType 521guaranteed delivery services 277guaranteed delivery transactions

ending 280getting status of 280invoking service 281restarting 281retrieving results of 282starting 283

guaranteed one-way call 282

HhandleBizDoc 248header fields, adding to MIME object 196headers, changing HTTP 40hostingRedirector 436HTMLDecode 386HTMLEncode 387HTTP

changing header variables 40submitting requests to servers 37, 40

IIData objects, converting to XML strings 512identifierBag 436IDs, retrieving list of 306indexOf 387InputStream, converting to byte 153inserting table rows 94insertXReference 408installPackage 214instanceDetails 437instanceParms 437integers


invalid dates 69invoke, guaranteed delivery service 281invoking

client services 37remote services 277report services 295stored procedures 77

invoking a serviceguaranteed delivery 283protocols used 149remote webMethods Integration Server 278

IO services 153isLatchClosed 403iterating through XML nodes 519

JJDBC-related services 75

KkeepAliveConnections 331key string lookup 388keyedReference 437keys, obtaining a list in a data store 379keysOwned 438


I n d e x

Llatch operations

checking latch status 403closing 402opening 404

LDAP serveradding entries 156closing connections 158connecting to 157deleting entries 158listing bindings 160looking up an entry 162retrieving attribute definitions 158retrieving objectclass definitions 159searching for entries 163updating attributes for an entry 164

LDAP services 155length

of a string 388of documents in a list 274

listadding, retrieving, or replacing elements 167LDAP 160number of elements 173registered processors 351universal names 480

list services 167listProxyListeners 331listRegisteredConnections 333listRegistrationListeners 333literalObjectToProperty 236literalObjectToVariable 237literalStringToProperty 237literalStringToVariable 237literalToPartner 238load balancing, enabling and disabling 61loadDocument 498loadPKCS7CertChain 337loadXMLNode 522lockGlobalData 245locking a repository entry 379log off of FTP server 56logActivityMessages 246

loggingaudit events 133exception events 134pipeline fields 148process activity messages 246

login to FTP server 55logToFile

audit events 133exception events 134

lookup entry in an LDAP server 162lookupCorrelation 244lookupDictionary 388lookupTable 388lowercase, converting to 394ls 56

MmakeArrays 503makeString 389mapCIDtoPID 249mapping

between conversation ID and process instance ID 249deleting between processes 243

math services 177mdelete 57mergeHeaderAndBody 208messageFormat 390mget 57MIME messages

adding body parts to 192adding headers to 196creating 198creating encrypted messages 341creating signed messages 343decrypting 345discovering content type 203discovering number of parts 206discovering subtype 208generating message stream 204getting content from 200getting headers from 205getting part headers from 202getting top-level portion 207


Index

merging HTTP response into InputStream 208sending through SMTP 46signing and encrypting 222, 342verifying signed messages 346

MIME services 191model index, updating 234modifySubscriber 121mput 58multiplyFloatList 184multiplyFloats 185multiplyIntList 186multiplyInts 186multiplyObjects 187

Nnamespace components 321native ID, retrieving 407node iterator

creating 519freeXMLNode 518getNextXMLNode 519getXMLNodeIterator 519

notification error document type 271notifying services 398notifyPackageRelease 291numeric values

adding 179, 180, 181dividing 183multiplying 184, 185, 186, 187subtracting 188

numericFormat 390

Oobjectclass definitions 159objects


one-time tasksadding to scheduler 304updating to scheduler 311

one-way call, guaranteed 282

openLatch 404output templates 295overviewDoc 438

Ppackage management services 211Package Release Registry

adding entries 286deleting entries 287obtaining local server list 290

package replication services 285packageCreation 292packages

activating 212disabling 213enabling 214installing 214recovering 215reloading 216scanning 234

padLeft 391padRight 392partners, role information for processes 250partnerToPartner 239partnerToVariable 239pattern strings, date patterns 66phone 438pipeline

applying templates to 298information for processes 232inserting Session object 143removing fields 141restoring previously saved 144saving contents to a file 146saving into memory 145tracing 148using previously saved keys and values 145validating against a document type 319

pipeline services 139PKCS7 signatures 219PKCS7 SignedData objects 220

creating 327PKI profiles 219


I n d e x

portStatus specification 124portStatusInfo document type 125process activity messages, logging 246process instance IDs, returning 244, 247process run-time services 229process status, changing 233processCertsOnlyData 344ProcessData document type 232processEncryptedData 224, 345processes

changing status 233deleting 246deleting mapping between 243deleting storage information 234pipeline information for processes 232role information for 250specification for correlation services 231terminating 233

processMessage 352processRPCMessage 353processSignedData 225, 346program code conventions in this document 23propertyToProperty 240propertyToVariable 240protocols, retrieving information about 143, 149proxy server

deleting connections to 329disabling listeners 329number of connections to 326, 330

pseudorandom number generator 187pub.art.connection

disableConnection 27enableConnection 27getConnectionStatistics 27queryConnectionState 28

pub.art.listenerdisableListener 28enableListener 29queryListenerState 29setListenerNodeConnection 29

pub.art.notificationdisableListenerNotification 30disablePollingNotification 30

enableListenerNotification 30enablePollingNotification 31queryListenerNotificationState 31queryPollingNotificationState 31setListenerNotificationNodeListener 32setPollingNotificationNodeConnection 32

pub.art.servicesetAdapterServiceNodeConnection 33

pub.art.transactioncommitTransaction 33rollbackTransaction 34setTransactionTimeout 34startTransaction 35

pub.clientftp 39http 40smtp 46soapHTTP 47soapRPC 49

pub.client.ftpappend 51cd 52cdls 52delete 53dir 53get 54login 55logout 56ls 56mdelete 57mget 57mput 58put 58quote 59rename 59sessioninfo 60

pub.clusterdisableServiceRedir 62disableSessionRedir 62getClusterHosts 63

pub.datecurrentDate 69dateBuild 70


Index

dateTimeBuild 71dateTimeFormat 72formatDate 72getCurrentDate 73getCurrentDateString 73

pub.dbcall 77clearTransaction 79close 80closeAll 81commit 81connect 82delete 84execSQL 85getProcInfo 89getProcs 90getTableInfo 91getTables 93insert 94query 96rollback 97startTransaction 98update 99

pub.documentdocumentListToDocument 102documentToDocumentList 103documentToXMLValues 104XMLValuesToDocument 105

pub.eventaddSubscriber 109alarm 112alarmInfo 113audit 113auditInfo 114callStackItem 114deleteSubscriber 115exception 116exceptionInfo 117gdEnd 117gdEndInfo 118gdStart 118gdStartInfo 119

getEventTypes 119getSubscribers 120modifySubscriber 121portStatus 124portStatusInfo 125reloadEventManagerSettings 125replication 126replicationInfo 126saveEventManagerSettings 127sessionEnd 127sessionEndInfo 128sessionExpire 128sessionExpireInfo 128sessionStart 129sessionStartInfo 129stat 130statInfo 131txEnd 132txEndInfo 132txStart 133txStartInfo 133

pub.event.auditlogToFile 133

pub.event.exceptionlogToFile 134

pub.filegetFile 136

pub.flowclearPipeline 141debugLog 141getLastError 141getRetryCount 142getSession 143getTransportInfo 143restorePipeline 144restorePipelineFromFile 145savePipeline 145savePipelineToFile 146setResponse 146throwExceptionForRetry 147tracePipeline 148transportInfo 149


I n d e x

pub.iobytesToStream 154streamToBytes 154

pub.ldapbind 156connect 157delete 158disconnect 158getAttributeDef 158getClassDef 159list 160lookup 162search 163update 164

pub.listappendToDocumentList 168appendToRecordList 169appendToStringList 170copyListItem 170getListItem 171getRecordListItem 171getStringListItem 171setListItem 172setRecordListItem 172setStringListItem 172sizeOfList 173stringListToDocumentList 173stringListToRecordList 174

pub.mathaddFloatList 179addFloats 180addIntList 180addInts 181addObjects 181divideFloats 182divideInts 183divideObjects 183multiplyFloatList 184multiplyFloats 185multiplyIntList 186multiplyInts 186multiplyObjects 187randomDouble 187

subtractFloats 188subtractInts 188subtractObjects 189

pub.mimeaddBodyPart 192addMimeHeader 196createMimeData 198getBodyPartContent 200getBodyPartHeader 202getContentType 203getEnvelopeStream 204getMimeHeader 205getNumParts 206getPrimaryContentType 207getSubContentType 208mergeHeaderAndBody 208

pub.packagesactivatePackage 212disablePackage 213enablePackage 214installPackage 214recoverPackage 215reloadPackage 216

pub.pki.pkcs7sign 220verify 221

pub.pki.smimecreateSignedAndEncryptedData 222createSignedData 223processEncryptedData 224processSignedData 225

pub.prtCorrelationService 231ProcessData 232

pub.prt.adminchangeProcessStatus 233deleteProcess 234scanPackage 234

pub.prt.assignexpToProperty 235expToVariable 236literalObjectToProperty 236literalObjectToVariable 237


Index

literalStringToProperty 237literalStringToVariable 237literalToPartner 238partnerToPartner 239partnerToVariable 239propertyToProperty 240propertyToVariable 240setPartnerAuthentication 241variableToPartner 241variableToProperty 242variableToVariable 242

pub.prt.correlatedeleteCorrelation 243establishCorrelation 243lookupCorrelation 244

pub.prt.globalDatalockGlobalData 245

pub.prt.loglogActivityMessages 246

pub.prt.tndeleteByCID 246getPIDforCID 247getRoleInfo 248handleBizDoc 248mapCIDtoPID 249RoleInfo 250

pub.publishdeliver 254deliverAndWait 256documentResolverSpec 258envelope 259getRedeliveryCount 263publish 264publishAndWait 266reply 268waitForReply 270

pub.publish.notificationerror 271

pub.recordlength 274recordListToRecord 274recordToRecordList 275

recordToXMLValues 276XMLValuesToRecord 276

pub.remoteinvoke 278

pub.remote.gdend 280getStatus 280invoke 281restart 281retrieve 282send 282start 283submit 283

pub.replicatoraddReleaseRegistryEntry 286deleteReleaseRegistryEntry 287distributeViaFTP 288distributeViaSvcPull 289distributeViaSvcPush 289generateReplicationEvent 289getLocalReleasedList 290getRemoteReleasedList 290notifyPackageRelease 291packageCreation 292

pub.reportrunFileTemplate 296runFileTemplateOnPipe 297runStringTemplate 297runStringTemplateOnPipe 298runTemplate 298runTemplateOnPipe 299

pub.scheduleraddComplexTask 302addOnetimeTask 304addRepeatingTask 305cancelTask 306getTaskIDs 306getTaskInfo 307resumeTask 309suspendTask 309updateComplexTask 309updateOneTimeTask 311updateRepeatingTask 312


I n d e x

pub.schemacreateXSD 316validate 318validatePipeline 319

pub.schema.w3cdatatypes 320xml 321xsi 321

pub.securityclearKeyAndChain 325getNumConnections 326setKeyAndChain 326

pub.security.pkcs7sign 327verify 328

pub.security.reverseInvokedeleteAllConnections 329deleteConnection 329disableListeners 329getNumConnections 330getServerType 330keepAliveConnections 331listProxyListeners 331listRegisteredConnections 333listRegistrationListeners 333registerReverseConnections 335

pub.security.utilcreateMessageDigest 335getCertificateInfo 336loadPKCS7CertChain 337

pub.smimecreateCertsOnlyData 340createEncryptedData 341createSignedAndEncryptedData 342createSignedData 343processCertsOnlyData 344processEncryptedData 345processSignedData 346

pub.soap.processorlist 351processMessage 352processRPCMessage 353

registerProcessor 354unregisterProcessor 355

pub.soap.schemaencoding 356envelope 356

pub.soap.utilsaddBodyEntry 356addHeaderEntry 357addTrailer 359createSoapData 360exitUnableToUnderstand 360getActor 361getBody 361getBodyEntries 362getDocument 363getHeader 363getHeaderEntries 364getMustUnderstand 365getQName 366getTrailer 367QName 367removeBodyEntry 368removeHeaderEntry 368removeTrailer 369requestResponseSpec 370soapDataToString 371streamToSoapData 371stringToSoapData 372validateSoapData 373

pub.storageadd 376closeStore 377deleteStore 377get 378keys 379lock 379put 380registerStore 380remove 381unlock 381

pub.stringbase64Decode 385base64Encode 385


Index

bytesToString 385concat 386HTMLDecode 386HTMLEncode 387indexOf 387length 388lookupDictionary 388lookupTable 388makeString 389messageFormat 390numericFormat 390padLeft 391padRight 392replace 393stringToBytes 393substring 394tokenize 395toLower 394toUpper 394trim 395URLDecode 396URLEncode 396

pub.syncnotify 398wait 398

pub.synchronization.latchcloseLatch 402isLatchClosed 403openLatch 404

pub.synchronization.xrefcreateXReference 404deleteByObjectId 405deleteXReference 406getCanonicalKey 406getNativeId 407insertXReference 408

pub.tablerecordListToTable 410stringTableToTable 410tableToRecordList 411tableToStringTable 411

pub.uddi.client.doc

accessPoint 422address 423addressLine 423assertionStatusItem 424assertionStatusReport 425authToken 425bindingDetail 426bindingKey 426bindingTemplate 427bindingTemplates 427businessDetail 427businessDetailExt 428businessEntity 428businessEntityExt 429businessInfo 429businessInfos 430businessKey 430businessList 430businessService 431businessServices 431categoryBag 431contact 432contacts 432discoveryURL 433discoveryURLs 433dispositionReport 433docType_categoryBag 434docType_description 434docType_keyedReference 434docType_name 435email 435errInfo 435findQualifier 435findQualifiers 436fromKey 436hostingRedirector 436identifierBag 436instanceDetails 437instanceParms 437keyedReference 437keysOwned 438overviewDoc 438


I n d e x

phone 438publisherAssertion 439publisherAssertions 439registeredInfo 439relatedBusinessesList 440relatedBusinessInfo 440relatedBusinessInfos 440result 441schema_uddiv2 441serviceDetail 441serviceInfo 442serviceInfos 442serviceKey 442serviceList 442sharedRelationships 443SOAPFault 443tModelBag 444tModelDetail 444tModelInfo 445tModelInfos 445tModelInstanceDetails 445tModelInstanceInfo 445tModelKey 446tModell 443tModelList 446toKey 447uploadRegister 447

pub.uddi.client.inquiryfind_binding 447find_business 448find_businessByCategory 449find_businessByDiscURLs 450find_businessByIdentity 450find_businessByName 451find_businessBytModel 452find_relatedBusinesses 453find_service 454find_serviceByBusKey 455find_serviceByCategory 456find_serviceByName 457find_serviceBytModel 458find_tModel 459find_tModelByCategory 460

find_tModelByIdentity 460find_tModelByName 461get_bindingDetail 462get_businessDetail 463get_businessDetailExt 464get_serviceDetail 464get_tModelDetail 465

pub.uddi.client.publishadd_publisherAssertions 466delete_binding 467delete_business 467delete_publisherAssertions 468delete_service 469delete_tModel 470discard_authToken 470get_assertionstatusReport 471get_authToken 472get_publisherAssertions 473get_registeredInfo 474save_binding 475save_business 475save_service 476save_tModel 477set_publisherAssertions 478

pub.universalNamefind 480list 480

pub.webcreateRegions 484documentToRecord 486freeDocument 494getDocumentType 494getNextNode 495getNodeIterator 496loadDocument 498makeArrays 503queryDocument 503recordToDocument 505stringToDocument 510

pub.xmldocumentToXMLString 512freeXMLNode 518getNextXMLNode 519


Index

getXMLNodeIterator 519getXMLNodeType 521loadXMLNode 522queryXMLNode 527xmlNodeToDocument 529xmlStringToXMLNode 536

publish service 264publish/subscribe, latching and cross-referencing operations 401publishAndWait service 266publisherAssertion 439publisherAssertions 439publishing packages 285

addReleaseRegistryEntry 286deleteReleaseRegistryEntry 287distributeViaFTP 288distributeViaSvcPull 289distributeViaSvcPush 289generateReplicationEvent 289getLocalReleasedList 290getRemoteReleasedList 290notifyPackageRelease 291packageCreation 292

put (FTP) files 58

QQName document type 367queryConnectionState 28queryDocument 503querying a database 96queryListenerNotificationState 31queryListenerState 29queryPollingNotificationState 31queryXMLNode 527quote 59

Rrandom number generator 187randomDouble 187raw offset for time zones 67record services 273recordListToRecord 274recordListToTable 410records, deleting particular type 405

recordToDocument 505recordToRecordList 275recordToXMLValues 276recoverPackage 215recurring tasks, adding to scheduler 305redelivery count, retrieving for documents 263regions, defining 484registeredInfo 439registering data stores 380registerProcessor 354registerReverseConnections 335registerStore 380relatedBusinessesList 440relatedBusinessInfo 440relatedBusinessInfos 440relay server, disabling listeners 329release registry. See Package Release RegistryreloadEventManagerSettings 125reloadPackage 216remote file, appending data to 51remote procedure call, submitting 49remote servers, invoking services on 277, 278removeBodyEntry 368removeHeaderEntry 368removeTrailer 369removing entries from data stores 381renaming files on an FTP server 59repeating tasks, updating to scheduler 312replacing strings 393replication specification 126replicationInfo document type 126replicator services 285reply documents

for join conditions 269retrieving for asynchronous request 270sending 268volatile storage 269

reply service 268report services 295repository

closing data store 377creating/opening 380deleting data store 377


I n d e x

inserting entries 376inserting/updating entries 380list of keys in 379locking entries 379locking entries in 379registering 380removing entries 381retrieving keys from 379retrieving values from 378unlocking entries 381

request/reply modeldeliverAndWait service 257delivering a request 256multiple reply documents 267publishAndWait service 267publishing request 266publishing request to a specific client 256retrieving reply 270sending replies 268waitForReply service 270waiting for reply 257, 267

requestResponseSpec 370response string, forcing 146restarting a guaranteed delivery transaction 281restorePipeline 144restorePipelineFromFile 145result 441resumeTask 309retrieving

documents from a local file system 135files from FTP server 54MIME content 200MIME message headers 202, 205results of guaranteed delivery transaction 282

retrieving reply 270retry count, retrieving 142retry exception 147RoleInfo 250roles

fetching information 248information for 250

rollback 97rollbackTransaction 34

RPC, submitting 49runFileTemplate 296runFileTemplateOnPipe 297runStringTemplate 297runStringTemplateOnPipe 298runTemplate 298runTemplateOnPipe 299

SS/MIME messages

creating certs-only message 340creating encrypted messages 341creating signed messages 343creating using PKI profiles 219decrypting 224, 345extracting certificates from certs-only message 344verifying signed messages 225, 346

S/MIME services 339save_binding 475save_business 475save_service 476save_tModel 477saveEventManagerSettings 127savePipeline 145savePipelineToFile 146scanPackage 234scheduler

adding complex tasks 302adding one-time tasks 304canceling tasks 306recurring tasks 305resuming tasks 309retrieving list of task IDs 306retrieving task info 307suspending tasks 309updating complex tasks 309updating one-time tasks 311updating repeating tasks 312

scheduler services 301schema services 315schema_uddiv2 441schemas

attribute definition 158


Index

creating 316for validating 318namespace components 321objectclass definitions 159retrieving tables 93SOAP encoding schema 356SOAP envelope schema 356XML datatypes 320

searching an LDAP directory for entries 163security services 323sending a guaranteed call 282server log

pipeline field names and values 148writing to 141

servers, cluster listing 63serviceDetail 441serviceInfo 442serviceInfos 442serviceKey 442serviceList 442services

default access permissions 23listing of 21

Session object, inserting in pipeline 143sessionEnd specification 127sessionEndInfo document type 128sessionExpire specification 128sessionExpireInfo document type 128sessioninfo 60sessionStart specification 129sessionStartInfo document type 129set_publisherAssertions 478setAdapterServiceNodeConnection 33setKeyAndChain 326setListenerNodeConnection 29setListenerNotificationNodeListener 32setListItem 172setPartnerAuthentication 241setPollingNotificationNodeConnection 32setResponse 146setStringListItem 172setTransactionTimeout 34

sharedRelationships 443signed data object, creating 327SignedData objects 220signing and encrypting MIME messages 222signing MIME messages 223, 343, 346sizeOfList 173SMTP servers, submitting requests to 37, 40SMTP, sending MIME messages 46SOAP

actor attribute 361adding body entries 356adding header entries 357converting SOAP object to String 371converting stream to SOAP object 371converting string to SOAP object 372creating SOAP objects 360encoding schema 356envelope schema 356executing the default processor 352executing the default RPC processor 353getting body entries 361, 362, 367getting entire message 363getting header entries 363, 364getting QNames 366listing processors 351mustUnderstand attribute 360, 365registering a processor 354removing body entries 368removing header entries 368removing trailers 369sending a SOAP message 47specification for custom processor 370specification for target service 370submitting an RPC request 49unregistering processors 355validating SOAP objects 373

SOAP messages, inserting trailer 359SOAP services 349soapDataToString 371SOAPFault 443soapHTTP 47soapRPC 49


I n d e x

specificationsalarm event handler 112audit event handler 113CorrelationService 231exception event handler 116gdEnd 117gdStart 118portStatus event handler 124replication event handler 126sessionEnd event handler 127sessionExpire event handler 128sessionStart event handler 129stat event handler 130txEnd event handler 132txStart event handler 133

SQL statements, executing 85starting a guaranteed delivery transaction 283startTransaction 35, 98stat specification 130statInfo document type 131status of guaranteed delivery transactions 280storage information for processes, deleting 234storage services 375stored procedures

invoking 77retrieving information about 89retrieving names of 90

streamToBytes 154streamToSoapData 371string array, formatting 390stringListToDocumentList 173stringListToRecordList 174strings

adding to list 170base64 decoding 385base64 encoding 385byte array conversion 385concatenating 386concatenating an array of strings 389converted from documents 104converting list to document list 173

converting to byte array 393converting to lowercase 394converting to uppercase 394decoding URL-encoded 396HTML to native characters 386length of 388native characters to HTML 387padding beginning 391padding end 392replacing all 393returning substring of 394tokenizing into an array 395transformation services 383trimming white space 395URL-encoding 396XML values to a document 105

stringTableToTable 410stringToBytes 393stringToDocument 510stringToSoapData 372submitting an asynchronous call to a remote server 283subscribing to packages 285subscriptions, creating 109substring 394

indexing first occurrence 387subtractFloats 188subtractInts 188subtractObjects 189subtype, getting from MIME message 208sum of numeric values 179, 180, 181suspended tasks, resuming 309suspendTask 309synchronization services

coordinating the execution of services 397performing latching and cross-referencing operations 401

synchronous call to a remote server 281synchronous request/reply

delivering a request 257description of 257, 268publishing a request 267


Index

Ttable services 409tables

converting into two-dimensional array 411converting string table into 410inserting rows 94removing rows 84retrieving column information 91retrieving names of 93retrieving rows from 96updating all rows 99

tableToRecordList 411tableToStringTable 411tasks

adding complex to scheduler 302adding one-time to scheduler 304adding recurring to scheduler 305obtaining information about 307removing from scheduler 306resuming 309retrieving IDs for 306suspending 309updating complex to scheduler 309updating one-time to scheduler 311updating repeating to scheduler 312

templatesapplying to a document 296applying to pipeline 297, 298from string objects 297

time zones 67time, converting formats 72time/date transformation services 65tModel 443tModelBag 444tModelDetail 444tModelInfo 445tModelInfos 445tModelInstanceDetails 445tModelInstanceInfo 445tModelKey 446tModelList 446tokenizing a string 395toKey 447

toLower 394toUpper 394tracePipeline 148Trading Networks

BixDocEnvelope 248correlating conversation IDs to process IDs 243returning internal ID 248

trailers, adding to SOAP messages 359transactional state, clearing 79transactions, ending guaranteed delivery 280transforming

date formats 65time formats 65

transient error, description of 148transportInfo 149trigger services

retry count 142retrying 147

trimming white space 395troubleshooting information 24txEnd specification 132txEndInfo document type 132txStart specification 133txStartInfo document type 133typographical conventions in this document 23

UUDDI services 413universal name services 479universal names

finding service names for 480listing the registry 480

unlocking entries in data stores 381unregisterProcessor 355unsubscribing from an event 115updateComplexTask 309updateOneTimeTask 311updateRepeatingTask 312updating

attributes in an LDAP directory 164rows in a database table 99

uploadRegister 447uppercase, converting to 394


I n d e x

URLDecode 396URLEncode 396

VvalidatePipeline 319validateSoapData 373validating an object 318variableToPartner 241variableToProperty 242variableToVariable 242verifying digital signatures 328verifying signed data objects 221volatile storage, for reply documents 269

WwaitForReply service 270waiting for delivery from a notifying service 398Web services 483white space, trimming 395working directory, changing 52

XXML

datatypes 320pub.schema.w3c 321

XML documentsconverting to IData objects 529converting to XML nodes 536

XML nodesconverting 486creating from XML string 536extracting data from 527freeing 518freeing resoruces 494getting type info 521information about 494loading from URL 522querying 527

XML services 511XML strings, creating from documents 512XML values

converting from a document 104converting to a document 105

xmlNodeToDocument 529xmlStringToXMLNode 536XMLValuesToDocument 105XMLValuesToRecord 276XQL queries 527


Index


I n d e x


Index


I n d e x
