7-1-1 Integration Server Built-In Services Reference

TitlePage
webMethods Integration Server

Built-In Services Reference
Version 7.1.1
January 2008
webMethods
Copyright & Docu mentID
ThisdocumentappliestowebMethodsIntegrationServerVersion 7.1.1andwebMethodsDeveloperVersion 7.1.1andtoallsubsequent releases. Specificationscontainedhereinaresubjecttochangeandthesechangeswillbereportedinsubsequentreleasenotesorneweditions. CopyrightSoftwareAG2008. Allrightsreserved. ThenameSoftwareAGand/orallSoftwareAGproductnamesareeithertrademarksorregisteredtrademarksofSoftwareAG.Other companyandproductnamesmentionedhereinmaybetrademarksoftheirrespectiveowners. Document ID: IS-BIS-RF-711-20080128
Table of Contents
About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. ART Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art:listRegisteredAdapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.connection:disableConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.connection:enableConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.connection:getConnectionStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.connection:listAdapterConnections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.connection:queryConnectionState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.listener:disableListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.listener:enableListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.listener:listAdapterListeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.listener:queryListenerState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.listener:resumeListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.listener:setListenerNodeConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.listener:suspendListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:disableListenerNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:disablePollingNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:enableListenerNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:enablePollingNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:listAdapterListenerNotifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:listAdapterPollingNotifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:queryListenerNotificationState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:queryPollingNotificationState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:resumePollingNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:setListenerNotificationNodeListener . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:setPollingNotificationNodeConnection . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.notification:suspendPollingNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.service:listAdapterServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.service:setAdapterServiceNodeConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.transaction:commitTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.transaction:rollbackTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.transaction:setTransactionTimeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.art.transaction:startTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 21 22 23 24 26 26 26 27 28 29 29 30 30 31 32 32 33 33 34 34 34 35 36 37 37 38 39 39 40 40 41 41 42 43 44
webMethods Integration Server Built-In Services Reference Version 7.1.1
Table of Contents
2. Assets Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 pub.asset:publish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 3. Client Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client:ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:append . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:cd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:cdls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:getCompletedNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:ls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:mdelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:mget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:mput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:putCompletedNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:quote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:rename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ftp:sessioninfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client:http . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ldap:add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ldap:bind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ldap:cancelNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ldap:compare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ldap:delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ldap:modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ldap:registerNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ldap:rename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client.ldap:search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client:smtp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client:soapClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client:soapHTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.client:soapRPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 50 52 55 56 56 57 58 58 61 61 64 64 65 66 67 68 69 70 70 71 72 77 79 79 80 81 82 83 85 86 87 89 93 97
4. Cluster Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 pub.cluster:getClusterHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Table of Contents
5. Date Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.date:dateBuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.date:dateTimeBuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.date:dateTimeFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.date:formatDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.date:getCurrentDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.date:getCurrentDateString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6. Db Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:clearTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:closeAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:execSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:getProcInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:getProcs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:getTableInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:getTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:insert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:rollback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:startTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.db:update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7. Document Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.document:documentListToDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.document:documentToDocumentList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.document:documentToXMLValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.document:XMLValuesToDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8. Event Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:addSubscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:alarmInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:audit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:auditInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:callStackItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:deleteSubscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
103 104 108 109 110 111 112 112 113 114 115 118 119 120 120 121 123 124 128 129 130 132 134 135 137 138 139 141 142 142 144 145 145 147 148 150 153 153 154 155 156 156 157
Table of Contents
pub.event:exceptionInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:gdEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:gdEndInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:gdStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:gdStartInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:getEventTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:getSubscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:jmsReceiveErrorEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:jmsSendErrorEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:modifySubscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:portStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:portStatusInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:reloadEventManagerSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:replicationInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:saveEventManagerSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:securityInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:sessionEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:sessionEndInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:sessionExpire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:sessionExpireInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:sessionStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:sessionStartInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:stat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:statInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:txEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:txEndInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:txStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.event:txStartInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
158 159 160 160 161 162 163 165 167 167 171 171 172 172 173 173 174 175 177 177 178 178 179 180 180 182 183 183 184 184
9. File Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 pub.file:getFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 10. Flow Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:clearPipeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:debugLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:getLastError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:getRetryCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:getSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:getTransportInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:restorePipeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:restorePipelineFromFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 192 193 193 194 195 196 196 197 198
Table of Contents
pub.flow:savePipeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:savePipelineToFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:setResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:setResponseCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:throwExceptionForRetry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:tracePipeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.flow:transportInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11. IO Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.io:bytesToStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.io:close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.io:createByteArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.io:mark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.io:markSupported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.io:read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.io:reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.io:skip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.io:streamToBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12. JMS Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in This Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms:acknowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms:batchTriggerSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms:createConsumer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms:documentResolverSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms:JMSMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms:receive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms:reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms:send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms:sendAndWait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms:triggerSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms:waitForReply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms.wmjms:receiveStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.jms.wmjms:sendStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13. LDAP Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.ldap:bind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.ldap:connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.ldap:delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.ldap:disconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.ldap:getAttributeDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.ldap:getClassDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.ldap:list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.ldap:lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
199 199 200 201 201 202 203 207 208 208 209 209 210 210 211 211 212 212 213 214 215 215 216 220 221 224 229 236 245 261 261 266 268 271 272 272 273 274 274 275 276 277 278
Table of Contents
pub.ldap:search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 pub.ldap:update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 14. List Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.list:appendToDocumentList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.list:appendToStringList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.list:sizeOfList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.list:stringListToDocumentList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15. Math Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:addFloatList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:addFloats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:addIntList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:addInts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:addObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:divideFloats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:divideInts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:divideObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:multiplyFloatList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:multiplyFloats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:multiplyIntList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:multiplyInts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:multiplyObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:randomDouble . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:subtractFloats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:subtractInts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.math:subtractObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16. MIME Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:addBodyPart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:addMimeHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:createMimeData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:getBodyPartContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:getBodyPartHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:getContentType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:getEnvelopeStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:getMimeHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:getNumParts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:getPrimaryContentType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:getSubContentType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.mime:mergeHeaderAndBody . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283 284 284 285 285 286 287 288 289 290 290 291 291 292 293 293 294 295 296 296 297 298 298 299 299 301 302 303 307 308 311 313 314 315 317 318 319 319 320
Table of Contents
17. Packages Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.packages:activatePackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.packages:disablePackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.packages:enablePackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.packages:installPackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.packages:recoverPackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.packages:reloadPackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18. PKI Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.pki.pkcs7:sign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.pki.pkcs7:verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.pki.smime.createSignedAndEncryptedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.pki.smime.createSignedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.pki.smime:processEncryptedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.pki.smime:processSignedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19. Publish Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.publish:deliver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.publish:deliverAndWait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.publish:documentResolverSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.publish:envelope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.publish:getRedeliveryCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.publish:publish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.publish:publishAndWait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.publish:reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.publish:waitForReply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.publish.notification:error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20. Remote Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.remote:invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.remote.gd:end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.remote.gd:getStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.remote.gd:invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.remote.gd:restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.remote.gd:retrieve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.remote.gd:send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.remote.gd:start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
323 324 324 325 326 327 328 329 331 332 332 333 335 336 337 338 343 344 345 346 349 351 355 356 358 362 364 366 369 370 370 372 372 373 373 374 374 375
Table of Contents
pub.remote.gd:submit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376 21. Replicator Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.replicator:addReleaseRegistryEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.replicator:deleteReleaseRegistryEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.replicator:distributeViaFTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.replicator:distributeViaSvcPull . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.replicator:distributeViaSvcPush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.replicator:generateReplicationEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.replicator:getLocalReleasedList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.replicator:getRemoteReleasedList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.replicator:notifyPackageRelease . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.replicator:packageCreation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22. Report Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.report:runFileTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.report:runFileTemplateOnPipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.report:runStringTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.report:runStringTemplateOnPipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.report:runTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.report:runTemplateOnPipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23. Scheduler Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:addComplexTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:addOneTimeTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:addRepeatingTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:cancelTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:getTaskIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:getTaskInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:migrateTasksToJDBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:resumeTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:suspendTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:updateComplexTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:updateOneTimeTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.scheduler:updateRepeatingTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24. Schema Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.schema:createXSD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.schema:validate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.schema:validatePipeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377 378 379 380 381 381 382 382 382 383 384 384 387 388 388 389 389 389 390 391 393 394 394 397 400 403 403 404 408 409 410 410 414 416 421 422 422 425 426
10
Table of Contents
pub.schema.w3c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427 pub.schema.w3c:xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428 pub.schema.w3c:xsi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428 25. Security Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security:clearKeyAndChain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security:setKeyAndChain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security:setKeyAndChainFromBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.outboundPasswords:setPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.outboundPasswords:getPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.outboundPasswords:listKeys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.outboundPasswords:removePassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.outboundPasswords:updatePassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.pkcs7:sign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.pkcs7:verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.util:createMessageDigest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.util:getCertificateInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.util:loadPKCS7CertChain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.util:createSecureString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.util:convertSecureString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.security.util:destroySecureString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26. SMIME Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.smime:createCertsOnlyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.smime:createEncryptedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.smime:createSignedAndEncryptedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.smime:createSignedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.smime:processCertsOnlyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.smime:processEncryptedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.smime:processSignedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27. SOAP Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.handler:listConsumer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.handler:listProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.handler:registerConsumer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.handler:registerProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.handler:unregisterConsumer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.handler:unregisterProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.processor:list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.processor:processMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.processor:processRPCMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.processor:registerProcessor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.processor:unregisterProcessor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429 430 431 432 433 433 435 436 436 437 437 438 440 440 441 441 442 443 445 446 446 447 448 449 451 451 453 457 458 460 461 462 462 462 463 463 464 465 466 467
11
Table of Contents
pub.soap.schema:encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.schema:envelope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:addBodyEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:addHeaderEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:addTrailer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:createSoapData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:exitUnableToUnderstand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:getActor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:getBody . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:getBodyEntries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:getDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:getHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:getHeaderEntries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:getMustUnderstand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:getQName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:getTrailers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:QName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:removeBodyEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:removeHeaderEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:removeTrailer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:requestResponseSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:resetWSDEffectivePolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils.setWSDEffectivePolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:soapDataToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:streamToSoapData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:stringToSoapData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.soap.utils:validateSoapData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28. Storage Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Locking Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Data Store Locking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Automatic Promotion to Exclusive Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Wait Time and Duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.storage:add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.storage:closeStore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.storage:deleteStore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.storage:get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.storage:keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.storage:listLocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.storage:lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.storage:put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.storage:registerStore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
468 468 468 469 472 473 474 474 475 476 476 477 478 479 480 481 481 482 483 484 485 485 486 487 487 488 489 491 491 491 492 492 492 493 494 494 495 496 497 498 500 500
12
Table of Contents
pub.storage:releaseLocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501 pub.storage:remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502 pub.storage:unlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502 29. String Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:base64Decode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:base64Encode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:bytesToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:HTMLDecode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:HTMLEncode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:indexOf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:lookupDictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:lookupTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:makeString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:messageFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:numericFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:padLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:padRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:stringToBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:substring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:toLower . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:toUpper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:tokenize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:trim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:URLDecode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.string:URLEncode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30. Sync Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.sync:notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.sync:wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31. Synchronization Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.synchronization.latch:closeLatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.synchronization.latch:isLatchClosed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.synchronization.latch:openLatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.synchronization.xref:createXReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.synchronization.xref:deleteByObjectId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.synchronization.xref:deleteXReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505 506 507 507 508 508 508 509 510 510 510 511 512 512 513 514 515 515 516 516 517 517 518 518 518 519 521 522 522 522 525 526 526 527 528 528 529 530
13
Table of Contents
pub.synchronization.xref:getCanonicalKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530 pub.synchronization.xref:getNativeId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531 pub.synchronization.xref:insertXReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532 32. Trigger Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.trigger:createTrigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.trigger:deleteTrigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.trigger:disableJMSTriggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.trigger:enableJMSTriggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.trigger:resourceMonitoringSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.trigger:resumeProcessing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.trigger:resumeRetrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.trigger:suspendJMSTriggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.trigger:suspendProcessing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.trigger:suspendRetrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33. UDDI Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:accessPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:addressLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:assertionStatusItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:assertionStatusReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:authToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:bindingDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:bindingKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:bindingTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:bindingTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:businessDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:businessDetailExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:businessEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:businessEntityExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:businessInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:businessInfos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:businessKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:businessList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:businessService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:businessServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:categoryBag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:discoveryURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:discoveryURLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:dispositionReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535 536 536 544 545 547 548 550 553 556 558 561 565 566 575 577 577 578 578 579 580 580 581 581 581 582 583 583 584 584 584 584 585 585 586 586 587 587 587 588
14
Table of Contents
pub.uddi.client.doc:docType_categoryBag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:docType_description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:docType_keyedReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:docType_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:errInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:findQualifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:findQualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:fromKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:hostingRedirector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:identifierBag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:instanceDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:instanceParms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:keyedReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:keysOwned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:overviewDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:publisherAssertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:publisherAssertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:registeredInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:relatedBusinessInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:relatedBusinessInfos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:relatedBusinessesList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:schema_uddiv2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:serviceDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:serviceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:serviceInfos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:serviceKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:serviceList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:sharedRelationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:SOAPFault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:tModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:tModelBag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:tModelDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:tModelInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:tModelInfos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:tModelInstanceDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:tModelInstanceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:tModelKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:tModelList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:toKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.doc:uploadRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_business . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
588 589 589 589 589 590 590 590 590 590 591 591 591 592 592 592 592 593 593 594 594 595 595 595 596 596 597 597 597 597 598 598 598 599 599 600 600 600 601 601 601 602 602 602 603
15
Table of Contents
pub.uddi.client.inquiry:find_businessByCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_businessByDiscURLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_businessByIdentity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_businessByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_businessBytModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_relatedBusinesses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_serviceByBusKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_serviceByCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_serviceByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_serviceBytModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_tModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_tModelByCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_tModelByIdentity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:find_tModelByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:get_bindingDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:get_businessDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:get_businessDetailExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:get_serviceDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.inquiry:get_tModelDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:add_publisherAssertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:delete_binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:delete_business . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:delete_publisherAssertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:delete_service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:delete_tModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:discard_authToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:get_assertionstatusReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:get_authToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:get_publisherAssertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:get_registeredInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:save_binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:save_business . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:save_service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:save_tModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.uddi.client.publish:set_publisherAssertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34. UniversalName Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.universalName:find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.universalName:list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
604 605 606 606 607 608 609 610 611 612 613 614 615 616 617 618 618 619 620 621 622 622 623 624 625 625 626 627 628 629 630 631 632 633 634 634 637 638 638 638
35. Utils Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641 Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642 pub.utils:getServerProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
16
Table of Contents
36. VCS Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.vcs:getUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.vcs:removeCurrentUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.vcs:removeMultipleUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.vcs:setCurrentUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.vcs:setMultipleUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37. XML Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xml:documentToXMLString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xml:freeXMLNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xml:getNextXMLNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xml:getXMLNodeIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xml:getXMLNodeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xml:loadXMLNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xml:queryXMLNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xml:xmlNodeToDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xml:xmlStringToXMLNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38. XSLT Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of Elements in this Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xslt.Transformations:transformSerialXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xslt.Cache:removeAllTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pub.xslt.Cache:removeTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
643 644 644 645 645 646 647 649 650 650 657 657 658 660 661 667 669 678 681 682 682 684 684
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
17
Table of Contents
18
About This Guide

ThewebMethodsIntegrationServerBuiltInServicesReferencedescribesthebuiltinservices providedwithastandardinstallationofthewebMethodsIntegrationServer.Servicesare alsoinstalledwithwebMethodsaddonpackages,suchasadaptersandmonitoringtools. Youwillfinddocumentationforthoseservicesintheuserguideprovidedwiththeadd onproduct. Thedescriptionsinthisbookaredividedintothefollowingfolders.Thesefoldersreside intheWmPublicpackage,unlessspecifiedotherwise. Folder art Page 23 Contains services you use to (WmARTpackage)Manageadaptercomponents, includingconnections,adapterservices,listeners,and notifications. (WmAssetPublisherpackage)Publishmetadataabout IntegrationServerpackagesandTradingNetworksassets toaMetadataLibrary. FormulateandsubmitrequeststoHTTP,FTP,email,and LDAPservers. Deprecated.Enableand/ordisableloadbalancingfor specificservicesandsessionsinacluster. Generateandformatdatevalues. (WmDBpackage)AccessJDBCenableddatabases.The webMethodsJDBCAdapteralsoprovidesservicesthat performoperationsagainstJDBCenableddatabases.See theJDBCAdapterUsersGuideforinformation. Performoperationsondocumentsinthepipeline. Buildauditandeventhandlerservices. Performoperationsonthelocalfilesystem. Performdebuggingandutilitytypetasksinaflowservice. Convertdatabetweenbyte[]andInputStream representations. SendandreceiveJMSmessages. Deprecated.AccessandupdateinformationonanLDAP directoryserver.Useservicesintheclient.ldapfolder instead. Retrieve,replace,oraddelementsinanObjectList, DocumentList,orStringList;convertStringListsto DocumentLists.
assets
45
client cluster date db
49 101 103 113
document event file flow io jms ldap
141 147 187 191 207 213 271
list
283
19
About This Guide
Folder math mime packages pki
Page 287 301 323 331
Contains services you use to Add,subtract,multiply,ordividestringbasednumeric values. CreateMIMEmessagesandextractinformationfrom MIMEmessages. Install,load,and/oralterthestatusofapackageonthe IntegrationServer. (WmPKIpackage)CreateandverifyPKCS#7signatures withPKIprofilesandcreateandprocessS/MIMEmessages usingPKIprofiles. PublishanddeliverdocumentstootherIntegrationServers viawebMethodsBroker. InvokeservicesonremotewebMethodsIntegration Servers. ReplicatepackagesacrosswebMethodsIntegration Servers. Applyanoutputtemplatetothevaluesinthepipeline. Scheduleservicestoexecuteatthetimesyouspecify. Validateobjectsorvaluesinthepipeline. Controlwhichclientcertificatesaresenttootherservices andtodigitallysigndataandprocessdigitalsignatures. Storeandretrieveoutboundpasswordstoaccesssecure resources. Createdigitallysignedand/orencryptedMIMEmessages. ProcesssignedandencryptedMIMEmessages. Send,receive,andretrievedatafromSOAPmessages. RegistercustomSOAPprocessors. Create,close,delete,andregisterrepositorydatastores. Insertandretrieveinformationfromdatastores. Performstringmanipulationandsubstitutionoperations. Coordinatetheexecutionofservices. Performlatchingandcrossreferencingoperationsina publishandsubscribeintegration. Createanddeletetriggersandmanagedocumentretrieval anddocumentprocessingforindividualBroker/local triggers.Enable,disable,orsuspendoneormoreJMS triggers.
publish remote replicator report scheduler schema security
343 369 377 387 393 421 429
smime soap storage string sync synchronization trigger
445 457 491 505 521 525 535
20
About This Guide
Folder UDDI
Page 565
Contains services you use to Deprecated.(WmUDDIpackage)QueryaboutWebservice informationandpublishanexistingIntegrationServer serviceasaWebservicetoaUDDIserver. ListthecontentsoftheUniversalRegistryandlookup servicesbytheiruniversalnames. Deprecated.ManageuserassociationsfortheVCS Integrationfeature. Retrievethevaluesofserverproperties PerformoperationsonXMLdocuments. TransformanXMLstreamintoabytearray,file,orXML node,andtomaintaintheXSLTstylesheetcache.
universalName vcs utils xml xslt
637 643 641 649 681
Builtinservicesgenerallyhavethefollowingdefaultaccesspermissions: For this type of permission... List Read Built-in services are assigned to this ACL... Developers. MembersoftheDevelopersACLcansee,inwebMethods IntegrationServerorDeveloper,thataserviceexists. WmPrivate.TheWmPrivateACLisavirtualACLdesignedtoprotect theproprietarycodeinthebuiltinservices.AsthisACLhasno members,nousercaneditaserviceorviewitssource. WmPrivate. Internal. MembersoftheInternalACLcanexecuteaservice.
Write Execute
Thesedefaultaccesspermissionscannotbechanged(thatis,anotherACLcannotbe selected).
Document Conventions
Convention Bold Italic Description Identifieselementsonascreen. Identifiesvariableinformationthatyoumustsupplyorchange basedonyourspecificsituationorenvironment.Identifiesterms thefirsttimetheyaredefinedintext.Alsoidentifiesserviceinput andoutputvariables. IdentifiesstoragelocationsforservicesonthewebMethods IntegrationServerusingtheconventionfolder.subfolder:service.
Narrow font
21
About This Guide
Convention
Typewriter font
Description Identifiescharactersandvaluesthatyoumusttypeexactlyor messagesthatthesystemdisplaysontheconsole. Identifieskeyboardkeys.Keysthatyoumustpress simultaneouslyarejoinedwiththe+symbol. Directorypathsusethe\directorydelimiterunlessthesubject isUNIXspecific. Optionalkeywordsorvaluesareenclosedin[].Donottypethe[] symbolsinyourowncode.
UPPERCASE \ []
Additional Information
ThewebMethodsAdvantageWebsiteathttp://advantage.webmethods.comprovides youwithimportantsourcesofinformationaboutwebMethodsproducts: Troubleshooting Information.ThewebMethodsKnowledgeBaseprovides troubleshootinginformationformanywebMethodsproducts. Documentation Feedback.ToprovidefeedbackonwebMethodsdocumentation,goto theDocumentationFeedbackFormonthewebMethodsBookshelf. Additional Documentation.Startingwith7.0,youhavetheoptionofdownloadingthe documentationduringproductinstallationtoasingledirectorycalled _documentation,locatedbydefaultunderthewebMethodsinstallationdirectory. Inaddition,youcanfinddocumentationforallwebMethodsproductsonthe webMethodsBookshelf.
22
ART Folder
YouusetheelementsintheARTfoldertomanageadaptercomponents;specifically,these elementsenableyoutomanageconnections,adapterservices,listeners,andnotifications. Thisfolderalsoprovideselementstomanageanybuiltintransactionmanagement servicessupportedbyyourwebMethods6.xadapter.Seethedocumentationprovided withyouradaptertodeterminewhetheryouradaptersupportsthetransaction managementservices.
23
1 ART Folder
Summary of Elements in this Folder

Thefollowingelementsareavailableinthisfolder: Element pub.art:listRegisteredAdapters Package and Description WmART.Returnsthedisplayname andadaptertypenameofall registeredadapters. WmART.Disablesaconnection node. WmART.Enablesanexisting connectionnode. WmART.Returnscurrentusage statisticsforaconnectionnode. WmART.Listsconnectionnodes associatedwithaspecifiedadapter. WmART.Returnsthecurrent connectionstate(enabled/disabled) anderrorstatusforaconnection node. WmART.Disablesalistener. WmART.Enablesanexisting listener. WmART.Listslistenersassociated withaspecifiedadapter. WmART.Returnsthecurrentstate foralistener. WmART.Resumesaspecified listener. WmART.Changestheconnection nodeusedbyaspecifiedlistener. WmART.Suspendsaspecified listener. WmART.Disablesalistener notification. WmART.Disablesapolling notification. WmART.Enablesanexisting listenernotification.
pub.art.connection:disableConnection pub.art.connection:enableConnection pub.art.connection:getConnectionStatistics pub.art.connection:listAdapterConnections pub.art.connection:queryConnectionState
pub.art.listener:disableListener pub.art.listener:enableListener pub.art.listener:listAdapterListeners pub.art.listener:queryListenerState pub.art.listener:resumeListener pub.art.listener:setListenerNodeConnection pub.art.listener:suspendListener pub.art.notification:disableListenerNotification pub.art.notification:disablePollingNotification pub.art.notification:enableListenerNotification
24
1 ART Folder
Element pub.art.notification:enablePollingNotification pub.art.notification:listAdapterListenerNotifications
Package and Description WmART.Enablesanexisting pollingnotification. WmART.Liststhelistener notificationsassociatedwitha specifiedadapter. WmART.Liststhepolling notificationsassociatedwitha specifiedadapter. WmART.Returnsthecurrentstate (enabled/disabled)foralistener notification. WmART.Returnsthecurrentstate forapollingnotification. WmART.Resumesaspecified pollingnotificationnode. WmART.Changesthelistenerused byaspecifiedlistenernotification. WmART.Changestheconnection nodeusedbyaspecifiedpolling notification. WmART.Suspendsaspecified pollingnotification. WmART.Listsadapterservices associatedwithaspecifiedadapter. WmART.Changestheconnection nodeusedbyaspecifiedadapter service. WmART.Commitsanexplicit transaction. WmART.Rollsbackanexplicit transaction. WmART.Manuallysetsa transactiontimeoutintervalfor implicitandexplicittransactions. WmART.Startsanexplicit transaction.
pub.art.notification:listAdapterPollingNotifications
pub.art.notification:queryListenerNotificationState
pub.art.notification:queryPollingNotificationState pub.art.notification:resumePollingNotification pub.art.notification:setListenerNotificationNodeListener pub.art.notification:setPollingNotificationNodeConnection
pub.art.notification:suspendPollingNotification pub.art.service:listAdapterServices pub.art.service:setAdapterServiceNodeConnection
pub.art.transaction:commitTransaction pub.art.transaction:rollbackTransaction pub.art.transaction:setTransactionTimeout
pub.art.transaction:startTransaction
25
1 ART Folder
pub.art:listRegisteredAdapters
WmART.Returnsthedisplaynameandadaptertypenameofallregisteredadapters. Input Parameters None. Output Parameters registeredAdapterList Document List Informationforeachadapterregisteredwiththe WmARTpackage. Key adapterDisplayName Description StringThelocalizednamethatthe IntegrationServerAdministrator displays. StringThenameoftheadapteras registeredwiththeWmARTpackage. Thisvaluecanbeusedasinputforthe inventoryservicesthattake adapterTypeNameasinput.
adapterTypeName
pub.art.connection:disableConnection
WmART.Disablesaconnectionnode. Input Parameters connectionAlias Output Parameters None. See Also pub.art.connection:enableConnection StringNameoftheconnectionnodeyouwanttodisable.
pub.art.connection:enableConnection
WmART.Enablesanexistingconnectionnode. Input Parameters connectionAlias StringNameoftheconnectionnodeyouwanttoenable.
26
1 ART Folder
Output Parameters None. See Also pub.art.connection:disableConnection
pub.art.connection:getConnectionStatistics
WmART.Returnscurrentusagestatisticsforaconnectionnode. Input Parameters aliasName Output Parameters connectionStatistics Document List Informationforeachconnectionnode. Key TotalConnections BusyConnections FreeConnections TotalHits Description IntegerCurrentnumberofconnection instances. IntegerNumberofconnectionscurrentlyin usebyservices,notifications,andlisteners. IntegerTotalnumberofconnectionscreated andavailableforuse. IntegerNumberoftimesthisconnectionnode successfullyprovidedconnectionssincethe lastreset. IntegerNumberoftimesthisconnectionnode unsuccessfullyprovidedconnectionssince thelastreset(whentherequesttimedout). StringNameoftheconnectionnodeforwhichyouwantusage statisticsreturned.
TotalMisses
See Also pub.art.connection:queryConnectionState
27
1 ART Folder
pub.art.connection:listAdapterConnections
WmART.Listsconnectionnodesassociatedwithaspecifiedadapter. Input Parameters adapterTypeName Output Parameters connectionDataList Document List Informationforeachconnectionnoderegistered withthespecifiedadapter. Key connectionAlias packageName connectionState Description StringThenameoftheconnectionnode. StringThenameofthepackageinwhichthe connectionnoderesides. StringCurrentstateoftheconnectionnode. Thestatewillhaveoneofthesevalues: Value
disabled enabled shuttingdown
StringThenameoftheadapterasregisteredwiththeWmART package.
Description Connectionnodeisdisabled. Connectionnodeisenabled. Connectionnodeisinthe processofshuttingdown. Connectionnodeis registeredbuthasnotyet establisheditsstate.
unknown
See Also pub.art:listRegisteredAdapters pub.art.connection:queryConnectionState
28
1 ART Folder
pub.art.connection:queryConnectionState
WmART.Returnsthecurrentconnectionstate(enabled/disabled)anderrorstatusfora connectionnode. Input Parameters connectionAlias Output Parameters connectionState hasError String Currentconnectionstate(enabled/disabled). Boolean Flagindicatingifanyerrorwasdetectedonconnection. Thevaluesare: Value
true false
StringNameoftheconnectionnodeforwhichyouwantthe connectionstateanderrorstatusreturned.
Description Anerrorwasdetected. Noerrorwasdetected.
See Also pub.art.connection:getConnectionStatistics pub.art.connection:enableConnection pub.art.connection:disableConnection
pub.art.listener:disableListener
WmART.Disablesalistener. Input Parameters listenerName forceDisable String Nameofthelisteneryouwanttodisable.Thelistener shouldhaveastateofenabledorsuspended. String Optional.Flagtodisablethelistenerregardlessofwhetherit isstillwaitingfordatafromabackendresource.Thestringmay haveoneofthesevalues: Value
true false
Description Forcethedisable. Donotforcethedisable.
29
1 ART Folder
Output Parameters None. See Also pub.art.listener:enableListener
pub.art.listener:enableListener
WmART.Enablesanexistinglistener. Input Parameters listenerName Output Parameters None. Usage Notes Ifyoudonotenabletheconnectionresourceassociatedwiththelistener,thisservice willreturnwithoutperforminganyaction,andthelistenerwillremaindisabled. Therefore,youshouldinvokepub.art.listener:queryListenerStatebeforecallingthisservice toconfirmthatthelistenerhasbeenenabled. See Also pub.art.listener:queryListenerState pub.art.listener:disableListener String Nameofthelisteneryouwanttoenable.
pub.art.listener:listAdapterListeners
WmART.Listslistenersassociatedwithaspecifiedadapter. Input Parameters adapterTypeName Output Parameters listenerDataList Document List Informationforeachlistenerregisteredwiththe specifiedadapter. Key listenerNodeName Description StringThenameofthelistener. StringThenameoftheadapterasregisteredwiththeWmART package.
30
1 ART Folder
packageName listenerEnabled
StringThenameofthepackageinwhichthe listenerresides. StringCurrentstateofthelistener.Thestate willhaveoneofthesevalues: Value

disabled enabled enablePending
Description Listenerisdisabled. Listenerisenabled. Listenerisintheprocessof starting. Listenerisintheprocessof disabling. Listenerissuspended. Listenerisintheprocessof suspending.
disablePending
suspended suspendPending
See Also pub.art:listRegisteredAdapters pub.art.listener:queryListenerState
pub.art.listener:queryListenerState
WmART.Returnsthecurrentstateforalistener. Input Parameters listenerName StringNameofthelistenerforwhichyouwantthecurrentstate returned.
Output Parameters listenerState String Currentstateofthelistener.Thestatewillhaveoneofthese values: Value

disabled enabled enablePending disablePending
Description Listenerisdisabled. Listenerisenabled. Listenerisintheprocessofstarting. Listenerisintheprocessofdisabling.
31
1 ART Folder
suspended suspendPending
Listenerissuspended. Listenerisintheprocessofsuspending.
See Also pub.art.listener:enableListener pub.art.listener:disableListener
pub.art.listener:resumeListener
WmART.Resumesaspecifiedlistener. Input Parameters listenerName Output Parameters None. Usage Notes Iftherequestedtransitionisnotvalid(forexample,tryingtoresumeadisabled listeneroralistenerthatisalreadyresumed),theserviceignorestherequest. Afteryouusethisservice,youcanusepub.art.listener:queryListenerStatetoverify pub.art.listener:resumeListenercorrectlychangedthestateofthelistener. See Also pub.art.listener:queryListenerState pub.art.listener:suspendListener StringThenameofthesuspendedlisteneryouwanttoresume.The servicereturnsanerrorifyouspecifyaninvalidlistener.
pub.art.listener:setListenerNodeConnection
WmART.Changestheconnectionnodeusedbyaspecifiedlistener. Input Parameters listenerName connectionAlias Output Parameters None. StringNameofthelistenerforwhichyouwanttochangethe connectionnode. StringNameofthenewconnectionnodetousewiththelistener.
32
1 ART Folder
Usage Notes Callingthisserviceforalistenerthatisdisabledispermitted. Callingthisserviceforalistenerthatissuspendedchangesthestateofthelistenerto

disabled.Theusermustenablethelistenerbeforeusingit.
See Also pub.art.listener:disableListener
pub.art.listener:suspendListener
WmART.Suspendsaspecifiedlistener. Input Parameters listenerName Output Parameters None. Usage Notes Iftherequestedtransitionisnotvalid(forexample,tryingtosuspendadisabled listeneroralistenerthatisalreadysuspended),theserviceignorestherequest. Afteryouusethisservice,youcanusepub.art.listener:queryListenerStatetoverify pub.art.listener:suspendListenercorrectlychangedthestateofthelistener. See Also pub.art.listener:queryListenerState pub.art.listener:resumeListener StringThenameofthelisteneryouwanttosuspend.Theservice returnsanerrorifyouspecifyaninvalidlistener.
pub.art.notification:disableListenerNotification
WmART.Disablesalistenernotification. Input Parameters notificationName Output Parameters None. StringThenameofthelistenernotificationyouwanttodisable.
33
1 ART Folder
See Also pub.art.notification:enableListenerNotification
pub.art.notification:disablePollingNotification
WmART.Disablesapollingnotification. Input Parameters notificationName Output Parameters None. See Also pub.art.notification:enablePollingNotification StringThenameofthepollingnotificationyouwanttodisable.The pollingnotificationshouldhaveastateofenabledorsuspended.
pub.art.notification:enableListenerNotification
WmART.Enablesanexistinglistenernotification. Input Parameters notificationName Output Parameters None. See Also pub.art.notification:disableListenerNotification StringThenameofthelistenernotificationyouwanttoenable.
pub.art.notification:enablePollingNotification
WmART.Enablesanexistingpollingnotification. Input Parameters notificationName Output Parameters None. StringNameofthepollingnotificationyouwanttoenable.
34
1 ART Folder
Usage Notes Youmustschedulethepollingnotificationbeforeyoucanrunthisservice.Seeyour adapteruserdocumentationforinstructionstoschedulethepollingnotification. See Also pub.art.notification:disablePollingNotification
pub.art.notification:listAdapterListenerNotifications
WmART.Liststhelistenernotificationsassociatedwithaspecifiedadapter. Input Parameters adapterTypeName Output Parameters notificationDataList Document List Informationforeachlistenernotification registeredwiththespecifiedadapter. Key notificationNodeName packageName notificationEnabled Description StringThenameofthelistener notification. StringThenameofthepackagein whichthelistenernotificationresides. StringThecurrentstateofthelistener notification.Thestatewillhaveoneof thesevalues: Value
no
Description Listenernotificationis disabled. Listenernotificationis enabled.
yes
See Also pub.art:listRegisteredAdapters pub.art.notification:queryListenerNotificationState
35
1 ART Folder
pub.art.notification:listAdapterPollingNotifications
WmART.Liststhepollingnotificationsassociatedwithaspecifiedadapter. Input Parameters adapterTypeName Output Parameters notificationDataList Document List Informationforeachpollingnotification registeredwiththespecifiedadapter. Key notificationNodeName packageName notificationEnabled Description StringThenameofthepolling notification. StringThenameofthepackagein whichthepollingnotificationresides. StringThecurrentstateofthepolling notification.Thestatewillhaveoneof thesevalues: Value
no
Description Pollingnotificationis disabled. Pollingnotificationis enabled. Pollingnotificationisinthe processofshuttingdown. Pollingnotificationis suspended.
yes
pending
suspended
See Also pub.art:listRegisteredAdapters pub.art.notification:queryPollingNotificationState
36
1 ART Folder
pub.art.notification:queryListenerNotificationState
WmART.Returnsthecurrentstate(enabled/disabled)foralistenernotification. Input Parameters notificationName Output Parameters notificationState See Also pub.art.notification:enableListenerNotification pub.art.notification:disableListenerNotification StringThecurrentstate(enabled/disabled)forthelistener notification. StringThenameofthelistenernotificationforwhichyouwantthe currentstate(enabled/disabled)returned.
pub.art.notification:queryPollingNotificationState
WmART.Returnsthecurrentstateforapollingnotification. Input Parameters notificationName Output Parameters notificationState scheduleSettings StringThecurrentstate(enabled,disabled,pendingdisable, pendingsuspend,orsuspended)forthepollingnotification. IData Objectthatcontainsthenotificationsschedulesettingsas follows: Key notificationInterval notificationOverlap Description IntegerPollingfrequencyofthenotification. BooleanFlagswhetherthenotificationcan overlap.Thevaluesare: Value
true false
StringThenameofthepollingnotificationforwhichyouwantthe currentstateandschedulesettingsreturned.
Description Thenotificationcanoverlap. Thenotificationcannotoverlap.
37
1 ART Folder
notificationImmediate
BooleanFlagswhetherthenotificationcan fireimmediately.Thevaluesare: Value

true
Description Thenotificationcanfire immediately. Thenotificationcannotfire immediately.
false
See Also pub.art.notification:enablePollingNotification pub.art.notification:disablePollingNotification
pub.art.notification:resumePollingNotification
WmART.Resumesaspecifiedpollingnotificationnode. Input Parameters notificationName Output Parameters None. Usage Notes Iftherequestedtransitionisnotvalid(forexample,tryingtoresumeadisabled pollingnotificationorapollingnotificationthatisalreadyresumed),theservice ignorestherequest. Afteryouusethisservice,youcanusepub.art.notification:queryPollingNotificationStateto verifypub.art.notification:resumePollingNotificationcorrectlychangedthestateofthepolling notificationtoenabled. See Also pub.art.notification:queryPollingNotificationState pub.art.notification:suspendPollingNotification StringThenameofthepollingnotificationyouwanttoresume.The servicereturnsanerrorifyouspecifyaninvalidpollingnotification.
38
1 ART Folder
pub.art.notification:setListenerNotificationNodeListener
WmART.Changesthelistenerusedbyaspecifiedlistenernotification. Input Parameters notificationName listenerNode Output Parameters None. Usage Notes Thisservicereturnsanerrorifthelistenernotificationisenabled. Youcanusethisserviceforsynchronousandasynchronouslistenernotifications. See Also pub.art.notification:disableListenerNotification StringNameofthelistenernotificationforwhichyouwantto changethelistener. StringNameofthenewlistenertousewiththelistenernotification.
pub.art.notification:setPollingNotificationNodeConnection
WmART.Changestheconnectionnodeusedbyaspecifiedpollingnotification. Input Parameters notificationName connectionAlias Output Parameters None. Usage Notes Thepollingnotificationmustbeinadisabledorsuspendedstatebeforeyoucallthis service.Thisservicereturnsanerrorifthepollingnotificationisenabled. Ifyouusethisserviceonasuspendedpollingnotification,theservicechangesthe stateofthepollingnotificationtodisabled. See Also pub.art.notification:disablePollingNotification StringNameofthepollingnotificationforwhichyouwantto changetheconnectionnode. StringNameofthenewconnectionnodetousewiththepolling notification.
39
1 ART Folder
pub.art.notification:suspendPollingNotification
WmART.Suspendsaspecifiedpollingnotification. Input Parameters notificationName StringThenameofthepollingnotificationyouwanttosuspend. Theservicereturnsanerrorifyouspecifyaninvalidpolling notification.
Output Parameters None. Usage Notes Iftherequestedtransitionisnotvalid(forexample,tryingtosuspendadisabled pollingnotificationorapollingnotificationthatisalreadysuspended),theservice ignorestherequest. Afteryouusethisservice,youcanusepub.art.notification:queryPollingNotificationStateto verifypub.art.notification:suspendPollingNotificationcorrectlychangedthestateofthepolling notificationtosuspended. See Also pub.art.notification:queryPollingNotificationState pub.art.notification:resumePollingNotification
pub.art.service:listAdapterServices
WmART.Listsadapterservicesassociatedwithaspecifiedadapter. Input Parameters adapterTypeName Output Parameters serviceDataList Document List Informationforeachadapterserviceregisteredwith thespecifiedadapter. Key serviceNodeName packageName Description StringThenameoftheadapterservice. StringThenameofthepackageinwhichthe adapterserviceresides. StringThenameoftheadapterasregisteredwiththeWmART package.
40
1 ART Folder
See Also pub.art:listRegisteredAdapters
pub.art.service:setAdapterServiceNodeConnection
WmART.Changestheconnectionnodeusedbyaspecifiedadapterservice. Input Parameters serviceName connectionAlias Output Parameters None. Usage Notes Thenewconnectionnodemustbeenabledbeforeyoucallthisservice. See Also pub.art.connection:enableConnection String Nameofanexistingadapterserviceforwhichyouwantto changetheconnectionnode. String Nameofthenewconnectionnodetousewiththeadapter service.
pub.art.transaction:commitTransaction
WmART.Commitsanexplicittransaction. Input Parameters commitTransactionInput Document List Informationforeachcommitrequest. Key transactionName Description StringThenameofanexplicittransaction thatyouwanttocommit.The transactionNamemusthavebeen previouslyusedinacallto pub.art.transaction:startTransaction. Thisvaluemustbemappedfromthemost recentpub.art.transaction:startTransactionthat hasnotpreviouslybeencommittedor rolledback.
41
1 ART Folder
Output Parameters None. Usage Notes Thisserviceisavailableonlyifyouradaptersupportsbuiltintransaction managementservices,whichyoucanconfirmbycheckingtheuserguideforthe adapter. Thisservicemustbeusedinconjunctionwiththepub.art.transaction:startTransaction service.IfthetransactionNameparameterwasnotprovidedinapriorcallto pub.art.transaction:startTransaction,aruntimeerrorwillbereturned. See Also pub.art.transaction:startTransaction pub.art.transaction:rollbackTransaction
pub.art.transaction:rollbackTransaction
WmART.Rollsbackanexplicittransaction. Input Parameters rollbackTransactionInput Document List Informationforeachrollbackrequest. Key transactionName Description StringThenameofanexplicit transactionthatyouwanttorollback. ThetransactionNamemusthavebeen previouslyusedinacallto pub.art.transaction:startTransaction. Thisvaluemustbemappedfromthe mostrecent pub.art.transaction:startTransactionthathas notpreviouslybeencommittedor rolledback. Output Parameters None. Usage Notes Thisserviceisavailableonlyifyouradaptersupportsbuiltintransaction managementservices,whichyoucanconfirmbycheckingtheuserguideforthe adapter.
42
1 ART Folder
Thisservicemustbeusedinconjunctionwiththepub.art.transaction:startTransaction service.IfthegiventransactionNameparameterwasnotprovidedinapriorcallto pub.art.transaction:startTransaction,aruntimeerrorwillbereturned. See Also pub.art.transaction:startTransaction pub.art.transaction:commitTransaction
pub.art.transaction:setTransactionTimeout
WmART.Manuallysetsatransactiontimeoutintervalforimplicitandexplicit transactions. Input Parameters timeoutSeconds IntegerThenumberofsecondsthattheimplicitorexplicit transactionstaysopenbeforethetransactionmanagermarksitfor rollback.
Output Parameters None. Usage Notes Thisserviceisavailableonlyifyouradaptersupportsbuiltintransaction managementservices,whichyoucanconfirmbycheckingtheuserguideforthe adapter. Whenyouusethisservice,youaretemporarilyoverridingtheIntegrationServer transactiontimeoutinterval. Youmustcallthisservicewithinaflowbeforethestartofanyimplicitorexplicit transactions.Implicittransactionsstartwhenyoucallanadapterserviceinaflow. Explicittransactionsstartwhenyoucallthepub.art.transaction:startTransactionservice. Iftheexecutionofatransactiontakeslongerthanthetransactiontimeoutinterval,all transactedoperationsarerolledback. Thisserviceonlyoverridesthetransactiontimeoutintervalfortheflowservicein whichyoucallit. See Also pub.art.transaction:startTransaction
43
1 ART Folder
pub.art.transaction:startTransaction
WmART.Startsanexplicittransaction. Input Parameters startTransactionInput Document List Informationforeachstarttransactionrequest. Key transactionName Description StringOptional.Specifiesthenameofthe transactiontobestarted.Ifyouleavethis parameterblank,theIntegrationServerwill generateanameforyou.Inmost implementationsitisnotnecessaryto provideyourowntransactionname.
Output Parameters startTransactionOutput Document List Informationforeachstarttransactionrequest. Key transactionName Usage Notes Thisserviceisavailableonlyifyouradaptersupportsbuiltintransaction managementservices,whichyoucanconfirmbycheckingtheuserguideforthe adapter. Thisserviceisintendedforusewiththepub.art.transaction:commitTransactionor pub.art.transaction:rollbackTransaction service. The transactionNamevaluereturnedbyacallto thisservicecanbeprovidedtopub.art.transaction:commitTransaction(tocommitthe transaction)orpub.art.transaction:rollbackTransaction(torollbackthetransaction). See Also pub.art.transaction:commitTransaction pub.art.transaction:rollbackTransaction Description StringThenameofthetransactionthe servicejuststarted.
44
Assets Folder
TheAssetsfoldercontainsthepublishservice(WmAssetPublisher.pub.assets:publish).Usethis servicetopublishmetadataaboutIntegrationServerpackagesandTradingNetworks assetstoaMetadataLibrary. MetadataisdataaboutassetsinwebMethodscomponents(forexample,assetsmodeled inwebMethodsDesigner,IntegrationServerpackages,orCentraSiteGEservices).A MetadataLibraryprovidesmetadatastorageandretrievalfeaturestowebMethods components. AMetadataLibraryoperatesasashareddatabaseofmetadata.Themainpurposeofa MetadataLibraryistoallowreuseofassetsamongusers.Ausermaypublishmetadata aboutanassettotheMetadataLibrary.Otheruserswillbeabletoseethepublished metadataandincorporatetheassetintotheirownprojects.Auserdoesnotdirectly accesstheMetadataLibrary.RatheritisaccessedbyotherwebMethodscomponents, namelywebMethodsDesigner,IntegrationServer,andCentraSiteGE. Formoreinformationaboutmetadata,seethewebMethodsMetadataLibraryUsersGuide.
45
2 Assets Folder

Thefollowingelementsareavailableinthisfolder: Element pub.asset:publish Package and Description WmAssetPublisher.Publishesmetadataaboutspecified IntegrationServerpackagesandTradingNetworks assetstoaMetadataLibrary.
pub.asset:publish
WmAssetPublisher.PublishesmetadataaboutspecifiedIntegrationServerpackagesand TradingNetworksassetstoaMetadataLibrary. Beforeyoucanusethisservice,youmustconfigureIntegrationServertoconnecttothe MetadataLibrary.Forinstructions,seethewebMethodsMetadataLibraryUsersGuide. Input Parameter
s
packages
String List Optional.ListofStrings(aString[])thatcontainsthenamesof packageswhosemetadatayouwanttopublish.Ifthisparameteris omitted,nometadataispublished. StringOptional.SpecifieswhethertopublishmetadataforTrading Networksassets. Set to...

true
tnassets
To... TopublishmetadataforTradingNetworksassets TonotpublishmetadataforTradingNetworksassets
false sync
StringOptional.Specifieswhethertolaunchthepublishprocessinthe currentthread(synchronously)orinaseparatethread(asynchronously). Set to...

true
To... Launchthepublishprocessinthecurrentserverthreadand notexitthisserviceuntilthepublishoperationhascompleted. Usethissettingwhenyouareinvokingthisservicefrom anotherserviceandyouwantthepublishoperationto completebeforetheserviceproceedstothenextstep. Launchthepublishprocessinaseparatethread.Usethis settingwhenyouareinvokingtheservicedirectlyfrom DeveloperorfromtheTestfunctionontheManagingServices screenoftheIntegrationServerAdministrator.Thissetting preventsyourbrowserfrombeingunavailablewhilethe publishoperationexecutes.Thisisthedefault.
false
46
2 Assets Folder
Output Parameters added String ListListofStrings(aString[])oftheassetsforwhichmetadata wasaddedtotheMetadataLibrary.Thearraycontainsalinefor eachasset.Eachlinecontainstheassetsnameandmetadatatype. Forexample,forapackagenamedListeners,alinewouldcontain Listenersandns.Package. String ListListofStrings(aString[])oftheassetsforwhichmetadata waschangedintheMetadataLibrary.Thearraycontainsalinefor eachasset.Eachlinecontainstheassetsnameandmetadatatype. Forexample,forapackagenamedListeners,alinewouldcontain Listenersandns.Package. String ListListofStrings(aString[])oftheassetsforwhichmetadata wasdeletedfromtheMetadataLibrary.Thearraycontainsalinefor eachasset.Eachlinecontainstheassetsnameandmetadatatype. Forexample,forapackagenamedListeners,alinewouldcontain Listenersandns.Package.
changed
deleted
47
2 Assets Folder
48
Client Folder
YouusetheelementsintheclientfoldertoformulateandsubmitrequeststoHTTP,FTP, LDAP,andemailservers.
49
3 Client Folder

Thefollowingelementsareavailableinthisfolder: Element pub.client:ftp pub.client.ftp:append pub.client.ftp:cd Package and Description WmPublic.PerformsaseriesofFTPactions. WmPublic.Appendsdatatoaremotefile. WmPublic.Changestheworkingdirectoryonthe FTPserver.(Thisservicecorrespondstothe standardFTPcommandcd dirpath.) WmPublic.Changestheworkingdirectoryonthe FTPserverandretrievesalistoffilenames.(This servicecorrespondstothestandardFTP commandscd dirpathandls namePattern.) WmPublic.Deletesafileinthecurrentworking directoryonanFTPserver.(Thisservice correspondstothestandardFTPcommand deletesomefile.) WmPublic.RetrievesthefilelistduringanFTP session.(Thisservicecorrespondstothestandard FTPcommanddir namepattern.) WmPublic.RetrievesafilefromaremoteFTP server.(Thisservicecorrespondstothestandard FTPcommandget.) WmPublic.Apublishabledocumenttypethat representsthedocumentpublishedtonotify partiesthatanFTPgetcommandhascompleted. WmPublic.ConnectstoaremoteFTPserverand logsinwithaspecifiedusernameandpassword. WmPublic.LogsoffoftheFTPserverandendsthe currentFTPsession. WmPublic.RetrievesthefilelistduringanFTP session.(Thisservicecorrespondstothestandard FTPcommandls namepattern.) WmPublic.Deletesmultiplefilesinthecurrent workingdirectoryonanFTPserver.(Thisservice correspondstothestandardFTPcommand mdelete pattern.) WmPublic.Transfersmultiplefilesfromtheremote FTPserver.(Thisservicecorrespondstothe standardFTPcommandmget.)
pub.client.ftp:cdls
pub.client.ftp:delete
pub.client.ftp:dir
pub.client.ftp:get
pub.client.ftp:getCompletedNotification
pub.client.ftp:login pub.client.ftp:logout pub.client.ftp:ls
pub.client.ftp:mdelete
pub.client.ftp:mget
50
3 Client Folder
Element pub.client.ftp:mput
Package and Description WmPublic.TransfersmultiplefilestoaremoteFTP server.(Thisservicecorrespondstothestandard FTPcommandinput.) WmPublic.TransfersafiletoaremoteFTPserver. (ThisservicecorrespondstothestandardFTP commandput.) WmPublic.Apublishabledocumenttypethat representsthedocumentpublishedtonotify partiesthatanFTPputcommandhascompleted. WmPublic.ExecutesagivenFTPcommand. WmPublic.RenamesafileonaremoteFTPserver. (ThisservicecorrespondstothestandardFTP commandrename.) WmPublic.Returnssessioninformationforallof theFTPserversthatusersarecurrentlyloggedinto. WmPublic.IssuesanHTTPrequestthatyou specifyandreturnstheHTTPresponse. WmPublic.Insertsanewentryintothedirectory. WmPublic.PerformsanLDAPbindoperationthat associatestheconnectionwiththespecified principal. WmPublic.Cancelsapreviouslycreated notificationrequest. WmPublic.Comparesthevalueofanattributein theLDAPdirectorywithavaluespecifiedbythe service. WmPublic.Removesanentryfromthedirectory. WmPublic.PerformsanLDAPmodifyoperation thatallowsyoutospecifyalistofattributeswith correspondinglistsofvaluestoaddto,replace,or removefromthedirectoryentry. WmPublic.Createsanotification(orpersistent search)thatcausesIntegrationServertolistenfor LDAPevents.Whenthenotificationgetsanevent, thespecifiedserviceiscalled. WmPublic.PerformsanLDAPrename(move) operationallowingyoutorenameanentry.
pub.client.ftp:put
pub.client.ftp:putCompletedNotification
pub.client.ftp:quote pub.client.ftp:rename
pub.client.ftp:sessioninfo pub.client:http pub.client.ldap:add pub.client.ldap:bind
pub.client.ldap:cancelNotification pub.client.ldap:compare
pub.client.ldap:delete pub.client.ldap:modify
pub.client.ldap:registerNotification
pub.client.ldap:rename
51
3 Client Folder
Element pub.client.ldap:search
Package and Description WmPublic.PerformsanLDAPsearchoperation withthespecifiedparametersandreturnsthe resultsofthesearch. WmPublic.SendsaMIMEtypeemailmessage. WmPublic.CreatesandsendsSOAP1.1andSOAP 1.2messagesoverHTTPorHTTPStransportsfor anystyle/usecombinationsupportedby IntegrationServer.Thisistheserviceusedbyall Webserviceconnectors. WmPublic.SubmitsaSOAPmessagetoaserver viaHTTPorHTTPS. WmPublic.SubmitsaSOAPremoteprocedurecall viaHTTPorHTTPS.
pub.client:smtp pub.client:soapClient
pub.client:soapHTTP pub.client:soapRPC
pub.client:ftp
WmPublic.PerformsaseriesofFTPactions. Thisserviceexecutesthefollowingsequence: 1 2 3 4 LogsontoanFTPserver. Changestoaspecifiedworkingdirectory. PerformsoneofthefollowingFTPcommands:ls,put,orget. LogsofftheFTPserver.
Input Parameters serverhost serverport username password command dirpath transfermode String NameorIPaddressoftheFTPserver(forexample,
ftp.netscape.com).
String PortnumberoftheFTPserver(forexample,4566). StringValidFTPuseroftheremoteFTPserver(forexample, anonymous). StringOptional.ValidpasswordoftheFTPuser. StringOneofthefollowingFTPcommands:ls,put,orget. StringWorkingdirectoryoftheFTPserver(forexample,/tmp/pub).If thedirectorydoesnotexist,theserverthrowsanexception. StringOneoftwoFTPfiletransfermodes:asciiorbinary.Thedefault isascii.
52
3 Client Folder
transfertype localfile
StringOneoftwoFTPdatatransfertypes:passiveoractive.The defaultisactive. StringWhencommandissettoput,thisparameterspecifiesthename ofthelocalfileyouwanttotransfer.(Ifcontentisspecified,thisfieldis ignored.) Whencommandissettoget,thisparameterspecifiesthenameofthe localfileinwhichyouwanttheretrievedcontentsaved.
remotefile
StringWhencommandissettoput,thisparameterspecifiesthename oftheremotefileinwhichyouwantthesavethedatayouare sending. Whencommandissettoget,thisparameterspecifiesthenameofthe remotefilethatyouwanttoretrieve.
content encoding
java.io.InputStream, byte[ ],orStringDatatobetransferredwhen commandissettoput. StringOptional.Charactersetinwhichthedocumentisencoded. SpecifyanIANAregisteredcharacterset(forexample,ISO-8859-1). ThisinformationisrequiredtocorrectlyconverttheStringobjectto byteswhenperformingaget.Ifparameterisnull,thedefaultJVM encodingisused.
serverencoding
StringOptional.Specifiestheencodingthisserviceusestoconvertthe incomingFTPcommandstringtoencodedbytesthataresupported byIANAandtheFTPserver.Iftheparameterisnull,theserviceuses theUTF8charactersettoencodetheFTPcommandStringtobytes. StringTime(measuredinmilliseconds)towaitforaresponsefromthe FTPserverbeforetimingoutandabortingtherequest.Defaultisto waitforever. StringOptional.IndicateswhethertosendaSTORoraSTOU(Store asUniqueFile)commandtotheremoteFTPserver. Set to...
true false
timeout
putunique
To... StringSendaSTOU(StoreasUniqueFile)command. StringDefault.SendaSTORcommand.
53
3 Client Folder
secure
DocumentIndicateswhethertheFTPsessioniswithasecureFTP server. Variables in secure auth Description StringThekindofauthenticationmechanismtouse: None,SSL,TLS,orTLS-P.

NonespecifiesthattheFTPsessioniswithanonsecure FTPserver.Thisisthedefault.IfthevalueofauthisNone,
thesecuredatavariableisignored.
TLS-PisashortcutthatisequivalenttothesequenceAUTH TLS,PBSZ 0,andPROT P.IfthevalueofauthisTLS-P,the
securedatavariableisignored. securedata StringUsethevaluefalseforaclientsendingPROTC (DataChannelProtectionLevelClear). UsethevaluetrueforaclientsendingPROTP(Data ChannelProtectionLevelPrivate). Note: Ifyoudonotsetavalue,thedefaultisfalse. cleanlinefeeds StringOptional.Indicateswhethertheserviceshouldretainorremove carriagereturncharactersattheendofeachlineoftext. Set to...
true false
To... StringDefault.Removecarriagereturns. StringRetaincarriagereturns.
newSession
StringOptional.FlagindicatingwhetheraanewFTPsessionwillbe createdforthisFTPoperation. Set to...

yes no
To... CreateanewsessionforthisFTPoperation Default.Usethecurrentsession,ifoneisavailable,for thisFTPoperation.
clientTimeout
StringOptional.Specifiestheidletimeout,measuredinseconds,for thisFTPsession.IfclientTimeoutissetto0(zero),thesessionwillnever timeout.Thedefaultis600seconds(10minutes).
Output Parameters command dirlist localfile StringFTPcommandthatwasexecuted(ls,get,orput). String List Filenamesreturnedbythelscommand. StringNameofthelocalfileusedforagetorputoperation.
54
3 Client Folder
remotefile content
StringNameoftheremotefileusedforagetorputoperation. byte[ ]Iflocalfilewasnotspecified,thisparametercontainstheContent objectsenttotheremoteserver(ifaputcommandwasexecuted)or receivedfromtheremoteserver(ifagetcommandwasexecuted). StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessage.
returncode returnmsg logmsg Usage Notes
IfyousettheauthvariableinthesecureparametertoSSL,TLS,orTLS-P,pub.client.ftp automaticallysendsthefollowingsequenceofFTPcommandspriortosendingthe USERcommand:

AUTH <SSL | TLS | TLS-P> PBSZ 0 PROT <P | C>
TheclientFTPserviceswillnotnegotiateforlesssecuritythanyouhavespecified withtheauthparameter.However,ifyousettheauthvariabletoNone,theclientFTP servicescanoperate(inanonsecuremode)withanyFTPserver. TheFTPserviceswillalwaysconnecttoasecureFTPserverusinganonsecure(SSL) socket.AftergettingavalidreplyfromtheAUTHcommand,theFTPserviceswill converttheconnectedsockettoanSSLsocketandinitiateSSLhandshaking.
pub.client.ftp:append
WmPublic.Appendsdatatoaremotefile. Iftheremotefiledoesnotexist,theservicecreatesthefile. Input Parameters sessionkey transfermode content localfile remotefile StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringFTPfiletransfermode(asciiorbinary).Thedefaultisascii. java.io.InputStream, byte[ ], or StringDatatobetransferredtothe remotefile. StringOptional.Nameofthelocalfiletoappendtotheremotefile. Usedonlywhencontentisnotspecified. StringNameoftheremotefiletowhichtoappendthedataspecified incontentorlocalfile.
55
3 Client Folder
Output Parameters returncode returnmsg logmsg StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession.
pub.client.ftp:cd
WmPublic.ChangestheworkingdirectoryontheFTPserver.(Thisservicecorresponds tothestandardFTPcommandcd dirpath.) Input Parameters sessionkey dirpath Output Parameters returncode returnmsg logmsg StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession. StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringDirectorytowhichyouwanttoswitchontheFTPserver.For example:pub
pub.client.ftp:cdls
WmPublic.ChangestheworkingdirectoryontheFTPserverandretrievesalistoffile names.(ThisservicecorrespondstothestandardFTPcommandscd dirpathandls namePattern.) Input Parameters sessionkey dirpath filenamepattern StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringDirectorytowhichyouwanttoswitchontheFTPserver(for example,pub). StringOptional.Patternthatspecifiesthefilenamestolist(for example,*.txt).
56
3 Client Folder
orderby
StringOptional.Theorderofthereturnedfilelist. Value of orderby

none
Description Default.SendsanNLSTcommandtotheremote FTPserver. Returnsthelistinorderofthetimestamp.Sends anNLSTtcommandtotheremoteFTPserver. Note: ThetcommandisnotpartoftheRFC959 standard.SomeFTPserversmaynotsupportthis command.Serversthatsupportthiscommand mayreturntheresultsineitherascendingor descendingorderofcreationtime.
timestamp
Output Parameters dirlist returncode returnmsg logmsg String ListListoffilenamesmatchingfilenamepattern. StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession.
pub.client.ftp:delete
WmPublic.DeletesafileinthecurrentworkingdirectoryonanFTPserver.(Thisservice correspondstothestandardFTPcommanddeletesomefile.) Input Parameters sessionkey remotefile StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringNameofthefiletobedeletedfromthecurrentworking directory.Forexample:text.txt Ifyouspecifypatternmatchingcharactersinremotefile,allfiles matchingthepatternwillbedeleted. Output Parameters returncode returnmsg logmsg StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession.
57
3 Client Folder
pub.client.ftp:dir
WmPublic.RetrievesthefilelistduringanFTPsession.(Thisservicecorrespondstothe standardFTPcommanddir namepattern.) Input Parameters sessionkey filenamepattern orderby StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringOptional.Patternthatspecifiesthenamesofthefilesto includeinthelist(forexample,*.txt). StringOptional.Theorderofthereturnedfilelist. Value of orderby
none
timestamp
Output Parameters dirlist returncode returnmsg logmsg String ListListoffilenamesmatchingfilenamepattern. StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession.
pub.client.ftp:get
WmPublic.RetrievesafilefromaremoteFTPserver.(Thisservicecorrespondstothe standardFTPcommandget.) Input Parameters sessionkey transfermode StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringFTPfiletransfermode(asciiorbinary).Thedefaultisascii.
58
3 Client Folder
localfile remotefile encoding
StringOptional.Nameofalocalfilewheretheretrievedfileistobe saved. StringNameoftheremotefile. StringOptional.Charactersetinwhichthefileisencoded.This variableisrequiredtoconvertthefiletobytescorrectly.Specifyan IANAregisteredcharacterset(forexample:ISO-8859-1). Ifthisvariableisnull,theencodingcurrentlysetfortheFTPsession isused.IfencodingwasneversetforthisFTPsession,thedefault JVMencodingisused.
largefilethreshold
StringOptional.Definesthesize(inbytes)ofalargefile;see UsageNotes. If you... Setto0 Then... Allfileswillbeconsideredlargefiles.Thismeans: Theoutputparameterislargefilewillalwaysbe true. Thefilecontentwillbereturnedintheoutput parametercontentstream(asa java.io.InputStreamobject). Theoutputparametercontentwillbenull. Settoany valuegreater than0 Anyfilelargerthanthevalueyouspecifywillbe consideredlarge.Thismeans: Theoutputparameterislargefilewillbetrue. Thefilecontentwillbereturnedintheoutput parametercontentstream(asa java.io.InputStreamobject). Theoutputparametercontentwillbenull. Leaveblank Nofileisconsideredlarge.Thismeans: Theoutputparameterislargefilewillalwaysbe false. Thefilecontentwillbereturnedintheoutput parametercontent(). Theoutputparametercontentstreamwillbe null.
59
3 Client Folder
cleanlinefeeds
StringOptional.Indicateswhethertheserviceshouldretainor removecarriagereturncharactersattheendofeachlineoftext. Set to...

true false
To... StringDefault.Removecarriagereturns. StringRetaincarriagereturns.
Output Parameters content returncode returnmsg logmsg islargefile byte[ ] Dataretrievedfromtheremotefile. StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession. StringIndicateswhetherthefileisconsideredtobelarge(as specifiedbytheinputparameterlargefilethreshold). A value of...
true false
Indicates that... Thefileislargerthanthevalueoflargethreshold. Thefileisnotlargerthanthevalueof largethreshold(orlargethresholdisblank).
contentstream Usage Notes
ObjectAnjava.io.InputStreamobject.
Thelargefilethresholdparameterimprovestheabilityofpub.client.ftp:gettoretrievelarger files.Ifaretrievedfileislargerthanthesizespecifiedinthelargefilethreshold parameter,andthelocalfileparameterisempty(whichmeanstheretrievedfileis retrievedtomemory,nottoafileondisk),theIntegrationServerstreamsthelargefile toatemporaryfile.Whilethiswillimprovethescalabilityofpub.client.ftp:get,itwillalso reducethethroughputoftheoperationbecausetheretrievedfilewillbewrittentoa temporaryfile. Tip! Duetotheimpacttothethroughputofpub.client.ftp:getwhenstreamingis enabled,youshouldsetthevalueforlargefilethresholdtoasufficientlylargevalue sothatitcausesonlyminimaldegradationtothroughputandyetallowsthe servicetoretrievelargefileswithoutencounteringanOutOfMemoryexception. See Also pub.io:close
60
3 Client Folder
pub.client.ftp:getCompletedNotification
WmPublic.Apublishabledocumenttypethatrepresentsthedocumentpublishedto notifypartiesthatanFTPgetcommandhascompleted. WhenausercompletesanFTPgetcommandinhisorherownuserdirectory(thatis, whentheRETRcommandiscompletedontheserversidebuttheserverhasnotyet acknowledgedtheclientwithreturncode226),aneventisfiredtonotifyinterested partiesbypublishingadocument.EDIpackagesthatsubscribetothisdocumentwill retrievethefilefromtheserver. Parameters username filename Usage Notes Bydefault,thispublishabledocumenttypeissettopublishlocallyonly.Thatis,when theIntegrationServerpublishesaninstancedocumentfor pub.client.ftp:getCompletedNotification,onlysubscriberslocatedonthesameIntegration Serverreceivethedocument. Ifyouwantinstancesofthispublishabledocumenttypetobepublishedto webMethodsBroker,youmustcreateacorrespondingBrokerdocumenttypeby synchronizing pub.client.ftp:getCompletedNotification withthewebMethodsBroker.For moreinformationaboutsynchronizingdocumenttypes,seethePublishSubscribe DevelopersGuide. StringTheloginusernamethroughtheFTPListener. StringTheabsolutepathnameofthefile.
pub.client.ftp:login
WmPublic.ConnectstoaremoteFTPserverandlogsinwithaspecifiedusernameand password. YoumustusethisservicetoinitiateanFTPsessionbeforeusingmostotherservicesin pub.client.ftp. Input Parameters serverhost serverport StringNameorIPaddressoftheFTPserver(forexample, ftp.netscape.com). StringPortnumberonwhichtheFTPserverlistensforrequests(for example,4566). Thedefaultis21.
61
3 Client Folder
dataport
StringOptional.Listenerportnumberofthedatatransferchannel(for example, 3345). Ifyoudonotspecifydataport,theIntegrationServerwillchoosethe listenerportnumber.Thisvalueisusedonlywhenthetransfertype valueisactive.
username password account
StringValidFTPuserontheremoteFTPserver(forexample, anonymous). StringOptional.ValidpasswordfortheFTPuserspecifiedinusername (forexample,someone@somewhere). StringOptional.TheusernameforanaccountontheFTPserver. SpecifyaccountifyourFTPhostrequiresaccountinformation.The accountisdefinedintheFTPprotocoltofurtheridentifytheuserthat isidentifiedbytheusernameandpasswordinputvariables. StringTypeoftheFTPdatatransfermode(passiveoractive).The defaultisactive. StringOptional.Defaultcharactersetforencodingdatatransferred duringthissession.SpecifyanIANAregisteredcharacterset(for example,ISO-8859-1). Ifyoudonotsetencoding,thedefaultJVMencodingisused. StringOptional.Specifiestheencodingthisserviceusestoconvertthe incomingFTPcommandstringtoencodedbytesthataresupported byIANAandtheFTPserver.Iftheparameterisnull,theserviceuses theUTF8charactersettoencodetheFTPcommandStringtobytes. StringOptional.Time(measuredinmilliseconds)towaitfora responsefromtheFTPserverbeforetimingoutandterminatingthe request.Thedefaultistowaitforever.
transfertype encoding
serverencoding
timeout
62
3 Client Folder
secure
DocumentIndicateswhethertheFTPsessioniswithasecureFTP server. Variables in secure auth Description StringThekindofauthenticationmechanismtouse: None, SSL,TLS,orTLS-P.

NonespecifiesthattheFTPsessioniswithanonsecure FTPserver.Thisisthedefault.Ifthevalueofauthis None,thesecuredatavariableisignored. TLS-Pisashortcutthatisequivalenttothesequence AUTH TLS,PBSZ 0,andPROT P.IfthevalueofauthisTLSP,thesecuredatavariableisignored.
securedata
StringUsethevaluefalseforaclientsendingPROTC (DataChannelProtectionLevelClear). UsethevaluetrueforaclientsendingPROTP(Data ChannelProtectionLevelPrivate). Note: Ifyoudonotsetavalue,thedefaultisfalse.
newSession
StringOptional.FlagindicatingwhetheraanewFTPsessionwillbe createdforthisFTPoperation. Set to...

yes no
To... CreateanewsessionforthisFTPoperation Default.Usethecurrentsession,ifoneisavailable,for thisFTPoperation.
clientTimeout
StringOptional.Specifiestheidletimeout,measuredinseconds,for thisFTPsession.IfclientTimeoutissetto0(zero),thesessionwillnever timeout.Thedefaultis600seconds(10minutes).
Output Parameters sessionkey returncode returnmsg logmsg StringUniquekeyforthecurrentFTPsession.Thissessionkeymust beprovidedtoexecutemostotherservicesinpub.client.ftp. StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession.
63
3 Client Folder
Usage Notes IfyousettheauthvariableinthesecureparametertoSSL,TLS,orTLS-P,pub.client.ftp:login automaticallysendsthefollowingsequenceofFTPcommandspriortosendingthe USERcommand:

AUTH <SSL | TLS | TLS-P> PBSZ 0 PROT <P | C>
TheclientFTPserviceswillnotnegotiateforlesssecuritythanyouhavespecified withtheauthparameter.However,ifyousettheauthvariabletoNone,theclientFTP servicescanoperate(inanonsecuremode)withanyFTPserver. TheFTPserviceswillalwaysconnecttoasecureFTPserverusinganonsecure(SSL) socket.AftergettingavalidreplyfromtheAUTHcommand,theFTPserviceswill converttheconnectedsockettoanSSLsocketandinitiateSSLhandshaking.
pub.client.ftp:logout
WmPublic.LogsoffoftheFTPserverandendsthecurrentFTPsession. Input Parameters sessionkey Output Parameters returncode returnmsg logmsg StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession. StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice.
pub.client.ftp:ls
WmPublic.RetrievesthefilelistduringanFTPsession.(Thisservicecorrespondstothe standardFTPcommandls namepattern.) Input Parameters sessionkey filenamepattern StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringOptional.Patternthatspecifiesthenamesofthefilesto includeinthelist(forexample,*.txt).
64
3 Client Folder
orderby
StringOptional.Theorderofthereturnedfilelist. Value of orderby

none
timestamp
Output Parameters dirlist returncode returnmsg logmsg Usage Note DuringanFTPsession,thisserviceusesthecharactersetspecifiedintheencoding parameterofthepub.client.ftp:loginservice.Ifthefilelistthisserviceretrievesincludes charactersfromotherlanguages,settheencodingparameterappropriately.Forexample, setencodingtoSJISforfilenamescontainingJapanesecharacters.Ifyoudonotset encodinginpub.client.ftp:login,thedefaultJVMencodingisused. String ListListoffilenamesmatchingfilenamepattern. StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession.
pub.client.ftp:mdelete
WmPublic.DeletesmultiplefilesinthecurrentworkingdirectoryonanFTPserver.(This servicecorrespondstothestandardFTPcommandmdelete pattern.) Input Parameters sessionkey filenamepattern StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringPatternthatspecifiesthenamesofthefilestobedeletedfrom thecurrentworkingdirectory(forexample,*.txt). Important! Ifyoudonotspecifyavalueforfilenamepattern,allfilesin theworkingdirectoryaredeleted.
65
3 Client Folder
Output Parameters returncode returnmsg logmsg StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession.
pub.client.ftp:mget
WmPublic.TransfersmultiplefilesfromtheremoteFTPserver.(Thisservicecorresponds tothestandardFTPcommandmget.) Input Parameters sessionkey transfermode localdir filenamepattern encoding StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringFTPfiletransfermode(asciiorbinary).Thedefaultisascii. StringDirectoryinthelocalfilesystemwheretheretrievedfilesare tobesaved(forexample,c:\temp\ftpfiles). StringPatternthatspecifiesthenamesofthefilestoberetrieved(for example,*.txt). StringOptional.Charactersetinwhichthefilesareencoded.This variableisrequiredtoconvertthefilestobytescorrectly.Specifyan IANAregisteredcharacterset(forexample,ISO-8859-1). Ifyoudonotspecifyencoding,theencodingassignedtotheFTP sessionisused.IftheencodingwasnotsetfortheFTPsession,the defaultJVMencodingisused. Output Parameters filenames returncode returnmsg logmsg String ListListoffilesretrievedfromtheremoteFTPserver. StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession.
66
3 Client Folder
pub.client.ftp:mput
WmPublic.TransfersmultiplefilestoaremoteFTPserver.(Thisservicecorrespondsto thestandardFTPcommandinput.) Input Parameters sessionkey transfermode localdir filenamepattern putunique StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringFTPfiletransfermode(asciiorbinary).Thedefaultisascii. StringLocaldirectorycontainingthefilesyouwanttotransfertothe remoteFTPserver(forexample,c:\temp\ftpfiles). StringPatternthatspecifiesthenamesofthefilestobetransferred (forexample,*.txt). StringOptional.IndicateswhethertosendaSTORoraSTOU(Store asUniqueFile)commandtotheremoteFTPserver. Set to...
true false
Output Parameters filenames returncode returnmsg logmsg Usage Note SomeFTPservers,suchastheIntegrationServerFTPListener,donotsupport puttingauniquefile.Whenusingthepub.client.ftp:putorpub.client.ftp:mputserviceto putauniquefiletoanFTPserverthatdoesnotsupportputtingauniquefile,youwill encounteranerrorlikethisone:
com.wm.app.b2b.server.ServiceException: 500 'STOU': command not understood.
String ListListoffilestransferredtotheremoteFTPserver. StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession.
67
3 Client Folder
pub.client.ftp:put
WmPublic.TransfersafiletoaremoteFTPserver.(Thisservicecorrespondstothe standardFTPcommandput.) Input Parameters sessionkey transfermode content localfile remotefile secure putunique StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringFTPfiletransfermode(asciiorbinary).Thedefaultisascii. java.io.InputStream, byte[ ], or StringDatatobetransferredtotheremote file. StringOptional.Nameofthelocalfiletobeappendedtotheremote file.Usedonlyifcontentisnotspecified. StringThenameoftheremotefile. DocumentIndicateswhethertheFTPsessioniswithasecureFTP server. StringOptional.IndicateswhethertosendaSTORoraSTOU(Storeas UniqueFile)commandtotheremoteFTPserver. Set to...
true false
Output Parameters returncode returnmsg logmsg Usage Notes SomeFTPservers,suchastheIntegrationServerFTPListener,donotsupport puttingauniquefile.Whenusingthepub.client.ftp:putorpub.client.ftp:mputservice toputauniquefiletoanFTPserverthatdoesnotsupportputtingauniquefile, youwillencounteranerrorlikethisone:
com.wm.app.b2b.server.ServiceException: 500 'STOU': command not understood.
StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession.
Whenaclientinvokesthisservicetotransportafile,theFTPlistenerdetermines thecontenthandlertousebasedonthefilesextension.Thecontenthandler convertsthefilecontenttotheinputvaluesfortheservicetoinvoke.The IntegrationServer_directory\lib\mime.typesfilecontainsthemappingsoffile extensiontocontenttype.
68
3 Client Folder
Bydefault,ifthisserviceencountersafilethathasnofileextension,thedefault contenthandlerisused.Tooverridethis,youcanconfigureanycontenthandler tohandlefilesthathavenofileextension.Todothis,addalineintheIntegration Server_directory\lib\mime.typesfilethatspecifiesthecontenttypeofthefiles withnoextension,andtheftp_no_extensionkey.Forexample,toallowacontent handlertoaccepttext/xmlfilesthathavenoextension,addthislinetoyour mime.typesfile:

text/xml ftp_no_extension
pub.client.ftp:putCompletedNotification
WmPublic.Apublishabledocumenttypethatrepresentsthedocumentpublishedto notifypartiesthatanFTPputcommandhascompleted. WhenausercompletesanFTPputcommandinhisorherownuserdirectory(thatis, whentheSTORcommandiscompletedontheserversidebuttheserverhasnotyet acknowledgedtheclientwithreturncode226),aneventisfiredtonotifyinterested partiesbypublishingadocument.EDIpackagesthatsubscribetothisdocumentwill retrievethefilefromtheserver. Parameters username filename Usage Notes Bydefault,thispublishabledocumenttypeissettopublishlocallyonly.Thatis,when theIntegrationServerpublishesaninstancedocumentfor pub.client.ftp:putCompletedNotification,onlysubscriberslocatedonthesameIntegration Serverreceivethedocument. Ifyouwantinstancesofthispublishabledocumenttypetobepublishedto webMethodsBroker,youmustcreateacorrespondingBrokerdocumenttypeby synchronizingpub.client.ftp:putCompletedNotificationwiththewebMethodsBroker.For moreinformationaboutsynchronizingdocumenttypes,seethePublishSubscribe DevelopersGuide. StringTheloginusernamethroughtheFTPListener. StringTheabsolutepathnameofthefile.
69
3 Client Folder
pub.client.ftp:quote
WmPublic.ExecutesagivenFTPcommand. YoucanusethisservicetoexecutenonstandardFTPcommands. Input Parameters sessionkey string Output Parameters returncode returnmsg logmsg StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession. StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringThecommandtobeexecutedontheFTPserver.Thisservice submitsthecommandexactlyasitisspecifiedinstring.
pub.client.ftp:rename
WmPublic.RenamesafileonaremoteFTPserver.(Thisservicecorrespondstothe standardFTPcommandrename.) Input Parameters sessionkey oldname newname Output Parameters returncode returnmsg logmsg StringStandardFTPprotocolreturncode. StringStandardFTPprotocolreturnmessage. StringFTPlogmessagesfortheentireusersession. StringUniquekeyforthecurrentFTPsession.Thesessionkeyis returnedbythepub.client.ftp:loginservice. StringFullyqualifiednameofthefileyouwanttorename(for example,temp/oldname.txt). StringNewfullyqualifiednameforthefile(forexample, temp/newname.txt).
70
3 Client Folder
pub.client.ftp:sessioninfo
WmPublic.ReturnssessioninformationforalloftheFTPserversthatusersarecurrently loggedinto. Input Parameters name Output Parameters sessioninfo Document List InformationaboutthecurrentFTPsessions.Each documentinsessioninforepresentsasinglesessionandcontainsthe followinginformation: Key serverhost serverport dataport username password account Description StringNameorIPaddressoftheFTPserver. StringPortnumberonwhichtheFTPserverlistensfor requests. StringListenerportofthedatatransferchannelused bythissession. StringUserloggedontoFTPserver. StringPasswordfortheFTPuserspecifiedinusername. StringConditional.Theusernameforanaccounton theFTPserver.TheaccountisdefinedintheFTP protocoltofurtheridentifytheuserthatisidentified bytheusernameandpasswordinputvariables. StringDatatransfermode(passiveoractive)usedby thissession. StringConditional.IANAcharactersetusedbythis session.Ifencodingisnotreturned,theencodingwas notexplicitlysetandthedefaultJVMencodingisin effect. Notused.Reservedforfutureuse.
transfertype encoding
Usage Notes WhenyoustartanFTPsessionwithpub.client.ftp:login,youcansettheoptionaldataport parametertospecifytheportnumberfordatatransfers.DuringtheFTPsession, pub.client.ftp:sessionInforeturnsthedataportparameterwiththeportnumberusedfor datatransfers. Ifyoudonotsetthedataportparameterinpub.client.ftp:login,theserverusesarandom portnumber.DuringtheFTPsession,pub.client.ftp:sessionInfowillreturna0forthe dataportparametertoindicatethattheportnumberusedfordatatransfersisrandom.
71
3 Client Folder
pub.client:http
WmPublic.IssuesanHTTPrequestthatyouspecifyandreturnstheHTTPresponse. Input Parameters url StringURLoftheresourcethatyouwanttoaccess.Forexample:
http://www.rubicon.com/orders/orders.html
Important! Thisstringmustbeginwithhttp:orhttps:. method StringSpecifiestheHTTPmethodyouwanttouse.Validvaluesare:

delete get head options post put trace
loadAs
StringOptional.Forminwhichyouwantthehttpservicetostorethe returneddocument. Set to...

bytes
To... Default.Returnthebodyoftheresponseasabyte[]. Usethisoptionifthebodywillbeusedasinputtoa servicethatoperatesonwholeHTMLorXML documents(forexample,pub.xml:queryXMLNode). Returnthebodyoftheresponseasa java.io.InputStream.Usethisoptionifthedocument willbeusedasinputtoaservicethatcanprocess documentsincrementally(forexample,Usage Notes).
stream
data
DocumentDatathatyouwantthehttpservicetosubmitwiththe HTTPrequest.Specifydatausingoneormoreofthefollowingkeys. Important! Whenyouusemorethanonekey,argsisappendedfirst, tableisappendedsecond,andstringisappendedlast.
72
3 Client Folder
Key args
Description DocumentOptional.Name=valuepairsthatyouwant thisservicetosubmittotheresourceinurl.Youcan useargstosubmitdataviathePOST,GET,orHEAD method. Tospecifydatausingargs,createoneStringelement foreachname=valuepairthatyouwanttosubmit, wheretheelementsnamerepresentsthenameportion ofthepairandtheelementsvaluerepresentsthe valueportionofthepair. Whenyouuseargs,thehttpservicewillautomatically: URLencodename=valuepair,soyoudonotneed toURLencodethevaluesyouspecifyinargs. Insertthe&characterbetweenpairs,soyoudo notneedtoincludeitinargs. Prefixtheentirequerystringwiththe? characterifitsubmitsthedatainargsviaaGETor HEAD.Youdonotneedtoincludethischaracter inargs. Whenyousubmitdatausingargs,thewebMethods IntegrationServerautomaticallysetsthevalueofthe ContentTypeheadertoapplication/x-www-formurlencoded. IfyouwanttoexplicitlyspecifyadifferentContent Typevalue,youmustsubmitthevalueusingthestring orbytesvariable.
73
3 Client Folder
table
String TableOptional.Datathatthehttpservicewill usetoconstructaquerystringtosubmittothe resourcespecifiedinurl. tableissimilartoargs,butitallowsyoutosubmit unnamedvaluesinaquerystring,notjust name=valuepairs. Tospecifydatausingtable,createonerowforeach valuethatyouwanttosubmit,wherethecontentsof column0oftheStringTablerepresentsthename portionofthepair(leavethiscolumnnulltosubmitan unnamedvalue)andthecontentsofcolumn1 representsthevalueportionofthepair. Whenyouusetable,thehttpservicewill automatically: URLencodename=valuepair,soyoudonotneed toURLencodethevaluesyouspecifyintable. Insertthe&characterbetweenthepairs(or unnamedvalues)thatitconstructs,soyoudonot needtoincludeitintable. Prefixtheentirequerystringwiththe? characterifitsubmitsthedataintableviatheGET method.Youdonotneedtoincludethischaracter intable. Whenyousubmitdatausingtable,thewebMethods IntegrationServerautomaticallysetsthevalueofthe ContentTypeheadertoapplication/x-www-formurlencoded.Ifyouwanttoexplicitlyspecifyadifferent ContentType,youmustsubmityourdatausingthe stringorbytesvariable.
74
3 Client Folder
string
StringOptional.Textthatyouwantthehttpserviceto submittotheresourceinurl.Youcanusestringto submitdataviathePOST,GET,orHEADmethod. Ifyouusestringtosubmitdata,makesurethatyou specifythestringexactlyasyouwantitpresentedin theHTTPrequest.(IfyouareusingtheGETorHEAD method,makesureyouURLencodethecontentsof string.) Note: Whenyouusestring,thehttpservicewill automaticallyprefixtheentirequerystringwith?if itsubmitsthedatainstringviaaGETorHEAD.You donotneedtoincludethischaracterinstring. WhenperformingaPOST,stringwillbesubmittedto theresourcedefinedbyurlasthebodyoftherequest message.
bytes
byte[ ] Optional.Datathatyouwantthisserviceto submittotheresourceinurl.Youcanusebytesto submitdataviathePOSTmethodonly. Important! Whenyouusebytesandanotherelement (args,table,orstring)tospecifydata,theservice appendsthedatafromtheargs,table,orstringelement tourl.Theserviceappendsargstourlfirst,table second,andstringlast.Theserviceencodesthedata fromthebyteselementinthebodyofthepost.Ifthe streamvariableisnotnull,bytesisignored.
mimeStream
java.io.InputStreamOptional.MIMEorSMIMEmessage thatyouwantthisservicetosubmittotheresourcein url.AmimeStreamiscreatedbythe pub.mime:getEnvelopeStream,pub.smime:createEncryptedData, orpub.smime:createSignedDataservices.Itcontainsboth headersandcontent.TheheadersinthemimeStream areappendedtothehttpheaders. YoucanusemimeStreamtosubmitdataviathePOST methodonly.
75
3 Client Folder
stream
java.io.InputStreamOptional.Datathatyouwantthe httpservicetosubmittotheresourceinurl.Youcan usestreamtosubmitdataviathePOSTmethodonly. Important! Whenyouusestreamandanotherelement (args,table,stringorbytes)tospecifydata,theservice appendsthedatafromtheargs,table,orstringelement tourl.Theserviceappendsargstourlfirst,table second,andstringlast.Theserviceencodesthedata fromthestreamelementinthebodyofthepost.Ifthe streaminputisnotnull,thebytesinputisignored.
encoding
StringOptional.CharactersetinwhichtheURLdata parametersareencoded(argsortableand/orstring). EncodingisrequiredtocorrectlyconverttheString objecttobyteswhengeneratingtheURLforapost. SpecifyanIANAregisteredcharacterset(for example,ISO-8859-1). Ifthisvariableisnull,thedefaultJVMencodingis used.Becausestringisusedinthebodyofthepost andnotusedforbuildingtheURL,youdonotneedto specifyencodingforthedataparameterstring.
auth
DocumentOptional.Authorizationinformationthatthehttpservice willsubmitiftheresourcespecifiedinurlisprotected. Key type Description StringTypeofauthenticationthatyouwantthis servicetousewhenitsubmitsthisrequest.Leavethis fieldblank,astheonlyoptioncurrentlyavailableis basicHTTPauthentication. StringUsernamethatthisservicewillsubmitwhen requestingaprotectedresource. StringPasswordassociatedwithuser.
user pass headers
DocumentOptional.Fieldsthatyouwanttoexplicitlyoverrideinthe HTTPrequestheaderissuedbythehttpservice. Specifyakeyinheadersforeachheaderfieldthatyouwanttoset, wherethekeysnamerepresentsthenameoftheheaderfieldand thekeysvaluerepresentsthevalueofthatheaderfield. Ifyoudonotsetheaders,thehttpserviceusesitsdefaultheader values.
timeout
StringOptional.Time(measuredinmilliseconds)towaitfora responsefromtheremoteserverbeforetimingoutandterminating therequest.Thedefaultvalueistowaitforever.
76
3 Client Folder
Output Parameters encodedURL header StringTheURLthatwassubmittedbypub.client:http.Thiswillcontain anyargumentsetinargs,table,orstring. DocumentConditional.HTTPresponseheaders. Key lines Description DocumentFieldsintheresponseheader,wherekey namesrepresentfieldnamesandvaluesrepresent fieldvalues. StringHTTPstatuscodeoftheresponse. StringHTTPstatusmessageoftheresponse. Description byte[ ]Conditional.BodyoftheHTTPresponse representedasabyte[ ].bytesisreturnedonlywhen theloadAsinputparameterissettobytes. java.io.InputStream Conditional.Thebodyofthe HTTPresponserepresentedasanInputStream. streamisreturnedonlywhentheloadAsinput parameterissettostream.
status statusMessage body Key bytes
DocumentBodyoftheHTTPresponse.
stream
Usage Notes Ifurlbeginswithhttps:,youcanusepub.security:setKeyAndChaintospecifythe certificatechain.Ifyoudonotspecifyacertificatechain,pub.client:httpusesthedefault outboundSSLcertificatesettingstoauthenticatetheresources. Ifpub.client:httpdoesnotreceivearesponsewithinthetimeoutperiodspecifiedinthe serverswatt.net.timeout parameter,itwillthrowanexception.Forinformation aboutthewatt.net.timeout parameter,seethewebMethodsIntegrationServer AdministratorsGuide.
pub.client.ldap:add
WmPublic.Insertsanewentryintothedirectory. Input Parameters url principal credentials StringOptional.URLofthedirectoryservertoconnectto.For exampleldap://servername:389. StringOptional.Theprincipalforthedirectoryserver. StringOptional.Credentialsforthedirectoryserver.
77
3 Client Folder
timeout ldapEnv
StringOptional.Connectiontimeoutinmilliseconds. RecordOptional.Key/valueparameterstobepassedtoJNDIto furtherdefinetheconnectionenvironment.SeeyourJNDI documentationorhttp://java.sun.com/products/jndi/docs.html formoreinformationaboutparametersyoucanpasstoJNDI. String Flagthatspecifieswhethertoclosetheconnectionafterthe servicefinishes. Set to...
yes no
close
To... Closetheconnection.Thisisthedefault. Leavetheconnectionopenandavailable.
dn attrs
StringThedistinguishednameofthenewentrytoaddtothe directory. Document ListOptional.LDAPattributesandtheircorresponding values.Ifanattributeisspecifiedmorethanonce,itwillbeassigned multiplevalues.Thefollowingexampleshowshowtospecifyauser nameofJohnSmithandonenickname.
attrsData
Document Optional.LDAPattributesandtheircorresponding values.Ifanattributeisspecifiedmorethanonce,itwillbeassigned multiplevalues.Thefollowingexampleshowshowtoassignauser nameofJohnSmithwithtwonicknames.
Output Parameters connectionHandle Usage Notes SpecifyonlyoneofattrsorattrsData.Ifyouspecifyboth,theserviceusesattrsandignores attrsData. ObjectOptional.Thereturnedconnectionobject.Returnedonlyif thecloseparameterissettono.
78
3 Client Folder
pub.client.ldap:bind
WmPublic.PerformsanLDAPbindoperationthatassociatestheconnectionwiththe specifiedprincipal. Input Parameters url principal credentials timeout ldapEnv StringURLoftheLDAPservertoconnectto. StringOptional.TheprincipalfortheLDAPserver. StringOptional.CredentialsfortheLDAPserver. StringOptional.Connectiontimeoutinmilliseconds. RecordOptional.Key/valueparameterstobepassedtoJNDIto furtherdefinetheconnectionenvironment.SeeyourJNDI documentationorhttp://java.sun.com/products/jndi/docs.htmlfor moreinformationaboutparametersyoucanpasstoJNDI. String Flagthatspecifieswhethertoclosetheconnectionafterthe servicefinishes. Set to...
yes no
close
Output Parameters connectionHandle ObjectOptional.Thereturnedconnectionobject.Returnedonlyif thecloseparameterissettono.
pub.client.ldap:cancelNotification
WmPublic.Cancelsapreviouslycreatednotificationrequest. Input Parameters url principal credentials timeout ldapEnv String Optional.URLoftheLDAPservertoconnectto. StringOptional.TheprincipalfortheLDAPserver. String Optional.CredentialsfortheLDAPserver. StringOptional.Connectiontimeoutinmilliseconds. RecordOptional.Key/valueparameterstobepassedtoJNDIto furtherdefinetheconnectionenvironment.SeeyourJNDI documentationorhttp://java.sun.com/products/jndi/docs.htmlfor moreinformationaboutparametersyoucanpasstoJNDI.
79
3 Client Folder
close
String Flagthatspecifieswhethertoclosetheconnectionafterthe servicefinishes. Set to...

yes no
dn connectionHandle scope
StringThedistinguishednameoftheentry. ObjectOptional.Connectionobjectreturnedbyapreviously invokedLDAPservice. StringThescopeofthesearch.Mustbeobject(onlysearchthe specifieddirectoryentry),onelevel(onlysearchtheimmediate childrenofthespecifieddirectoryentry),orsubtree(searchthe directory,itschildren,andalloftheirchildren).
pub.client.ldap:compare
WmPublic.ComparesthevalueofanattributeintheLDAPdirectorywithavalue specifiedbytheservice. Input Parameters url principal credentials timeout ldapEnv StringOptional.URLoftheLDAPservertoconnectto. StringOptional.TheprincipalfortheLDAPserver. StringOptional.CredentialsfortheLDAPserver. StringOptional.Connectiontimeoutinmilliseconds. RecordOptional.Key/valueparameterstobepassedtoJNDIto furtherdefinetheconnectionenvironment.SeeyourJNDI documentationorhttp://java.sun.com/products/jndi/docs.htmlfor moreinformationaboutparametersyoucanpasstoJNDI. StringFlagthatspecifieswhethertoclosetheconnectionafterthe servicefinishes. Set to...
yes no
close
80
3 Client Folder
dn connectionHandle attrName attrValue Output Parameters connectionHandle result
StringThedistinguishednameoftheentrywhoseattributevalue youwanttocomparetoattrValue. ObjectOptional.Connectionobjectreturnedbyapreviously invokedLDAPservice. StringNameoftheattributewhosevalueyouwanttocompareto attrValue. StringThestringtocompareagainstthevalueoftheattribute identifiedbyattrName.
ObjectOptional.Thereturnedconnectionobject.Returnedonlyif thecloseparameterissettono. String Theresultofthecompareoperation.Canbetrueor false.
pub.client.ldap:delete
WmPublic.Removesanentryfromthedirectory. Input Parameters url principal credentials timeout ldapEnv StringOptional.URLoftheLDAPservertoconnectto. StringOptional.TheprincipalfortheLDAPserver. StringOptional.CredentialsfortheLDAPserver. StringOptional.Connectiontimeoutinmilliseconds. RecordOptional.Key/valueparameterstobepassedtoJNDIto furtherdefinetheconnectionenvironment.SeeyourJNDI documentationorhttp://java.sun.com/products/jndi/docs.htmlfor moreinformationaboutparametersyoucanpasstoJNDI. StringFlagthatspecifieswhethertoclosetheconnectionafterthe servicefinishes. Set to...
yes no
close
dn connectionHandle
StringThedistinguishednameoftheentrytodelete. ObjectOptional.Connectionobjectreturnedbyapreviously invokedLDAPservice.
81
3 Client Folder
Output Parameters connectionHandle Usage Notes Thisservicedoesnotflaganerroriftheentryisnotdeleted.Onewaytocheckistouse pub.client.ldap:searchtosearchfortheentry.Iftheentryisnotfound,youknowithasbeen deleted. ObjectOptional.Thereturnedconnectionobject.Returnedonlyif thecloseparameterissettono.
pub.client.ldap:modify
WmPublic.PerformsanLDAPmodifyoperationthatallowsyoutospecifyalistof attributeswithcorrespondinglistsofvaluestoaddto,replace,orremovefromthe directoryentry. Input Parameters url principal credentials timeout ldapEnv StringOptional.URLoftheLDAPservertoconnectto. String Optional.TheprincipalfortheLDAPserver. StringOptional.CredentialsfortheLDAPserver. StringOptional.Connectiontimeoutinmilliseconds. Record Optional.Key/valueparameterstobepassedtoJNDIto furtherdefinetheconnectionenvironment.SeeyourJNDI documentationorhttp://java.sun.com/products/jndi/docs.htmlfor moreinformationaboutparametersyoucanpasstoJNDI. StringFlagthatspecifieswhethertoclosetheconnectionafterthe servicefinishes. Set to...
yes no
close
dn
String Thedistinguishednameoftheentrytomodify.
82
3 Client Folder
connectionHandle attrs
ObjectOptional.Connectionobjectreturnedbyapreviously invokedLDAPservice. Document List Optional.ForeachLDAPattributetochange, specifiestheattributename,thevaluesaffected,andtheactionto performonthosevalues.Thefollowingexampleshowshowto specifytheremovalofJohnSmithsnicknameJohnny.
pub.client.ldap:registerNotification
WmPublic.Createsanotification(orpersistentsearch)thatcausesIntegrationServerto listenforLDAPevents.Whenthenotificationgetsanevent,thespecifiedserviceiscalled. Input Parameters url principal credentials timeout ldapEnv StringOptional.URLoftheLDAPservertoconnectto. String Optional.TheprincipalfortheLDAPserver. StringOptional.CredentialsfortheLDAPserver. StringOptional.Connectiontimeoutinmilliseconds. RecordOptional.Key/valueparameterstobepassedtoJNDIto furtherdefinetheconnectionenvironment.SeeyourJNDI documentationorhttp://java.sun.com/products/jndi/docs.html formoreinformationaboutparametersyoucanpasstoJNDI. StringFlagthatspecifieswhethertoclosetheconnectionafter theservicefinishes. Set to...
yes no
close
dn
StringThedistinguishednameoftheentrytobemonitored.
83
3 Client Folder
connectionHandle scope
ObjectOptional.Connectionobjectreturnedbyapreviously invokedLDAPservice. StringThescopeofthesearch.Mustbeobject(onlysearchthe specifieddirectoryentry,onelevel(onlysearchtheimmediate childrenofthespecifieddirectoryentry),orsubtree(search thedirectoryentry,itschildren,andalloftheirchildren). StringThetargetservicetobeinvokedwhentheLDAPeventis retrieved. String Optional.IntegrationServerusertorunservice(thetarget servicetobeinvokedwhentheLDAPeventisretrieved).Ifyou donotspecifyauser,theservicerunsastheDefaultuser.Make sureuserhasthepermissionsnecessarytoruntheservice.Be carefulwhenassigningtheuserbecausenopasswordis requiredwheninvokingaserviceinthismanner.Itis recommendedthatyoucreateaspecialaccountjustforinvoking thetargetservice.
service user
Output Parameters connectionHandle Usage Notes Whenthepub.client.ldap:registerNotificationservicecreatesanotification,IntegrationServer listensforfourdifferenttypesofevents:objectAdded,objectRemoved,objectRenamed, andobjectChanged.Ifanyoneoftheseeventsistriggered,pub.client.ldap: registerNotification callsthespecifiedtargetserviceandpassestheseinputstoit:
.
ObjectOptional.Thereturnedconnectionobject.Returnedonly ifthecloseparameterissettono.
Pipeline Input type
Description Oneofthefollowingdependingonwhicheventwastriggered objectAdded,objectRemoved,objectRenamed, objectChanged. Distinguishednameoftheentrythattriggeredtheevent. AnyadditionalLDAPattributesfromtheevent. ApplicableonlyforobjectRenamedevent.Distinguishednameof theentrybeforeitwasrenamed.
dn attributes oldDn
Ifanerroroccurs,pub.client.ldap:registerNotificationplacesaninputcalledexceptioninthe pipeline.Thisinputincludesdetailsontheexceptionthatoccurred. SomeLDAPserversdonotsupportpersistentsearchesandthereforedonotsupport notifications.
84
3 Client Folder
pub.client.ldap:rename
WmPublic.PerformsanLDAPrename(move)operationallowingyoutorenamean entry. Input Parameters url principal credentials timeout ldapEnv StringOptional.URLoftheLDAPservertoconnectto. StringOptional.TheprincipalfortheLDAPserver. StringOptional.CredentialsfortheLDAPserver. StringOptional.Connectiontimeoutinmilliseconds. RecordOptional.Key/valueparameterstobepassedtoJNDIto furtherdefinetheconnectionenvironment.SeeyourJNDI documentationorhttp://java.sun.com/products/jndi/docs.htmlfor moreinformationaboutparametersyoucanpasstoJNDI. StringFlagthatspecifieswhethertoclosetheconnectionafterthe servicefinishes. Set to...
yes no
close
connectionHandle newDn Output Parameters connectionHandle
Object Optional.Connectionobjectreturnedbyapreviously invokedLDAPservice. StringThenewnamefortheentry.
ObjectOptional.Thereturnedconnectionobject.Returnedonlyif thecloseparameterissettono.
85
3 Client Folder
pub.client.ldap:search
WmPublic.PerformsanLDAPsearchoperationwiththespecifiedparametersand returnstheresultsofthesearch. Input Parameters url principal credentials timeout ldapEnv StringOptional.URLoftheLDAPservertoconnectto. StringOptional.TheprincipalfortheLDAPserver. String Optional.CredentialsfortheLDAPserver. StringOptional.Connectiontimeoutinmilliseconds. RecordOptional.Key/valueparameterstobepassedtoJNDIto furtherdefinetheconnectionenvironment.SeeyourJNDI documentationorhttp://java.sun.com/products/jndi/docs.htmlfor moreinformationaboutparametersyoucanpasstoJNDI StringFlagthatspecifieswhethertoclosetheconnectionafterthe servicefinishes. Set to...
yes
close
To... Closetheconnection.Thisisthedefault. Ifthecloseparameterissettoyes,the connectionHandleparametermustalsobemapped. Leavetheconnectionopenandavailable.
no
dn connectionHandle
StringThedistinguishednameindicatingtherootfromtobegin thesearch. ObjectRequiredifthecloseparameterissettoyes,otherwiseit isoptional.Connectionobjectreturnedbyapreviouslyinvoked LDAPservice. StringThescopeofthesearch.Mustbeobject(onlysearchthe specifieddirectoryentry),onelevel(onlysearchtheimmediate childrenofthespecifieddirectoryentry),orsubtree(searchthe directoryentry,itschildren,andalltheirchildren). StringThefilterstringconformingtoRFC2254.Formore informationaboutRFC2254,consult http://www.ietf.org/rfc/rfc2254.txt. StringOptional.Themaximumnumberofresultstoreturn(0,the default,indicatesnolimit). StringOptional.Thenumberofmillisecondstowaitforthesearch tocomplete(0,thedefault,indicatestowaitforever).
scope
filter
countLimit timeLimit
86
3 Client Folder
returnAttributes
RecordOptional.Alistofattributenamestoreturn(anempty arrayindicatesthatnoresultsshouldbereturned.Anullarray,the default,indicatesthatallattributesshouldbereturned). StringOptional.Specifieswhetherornotobjectsassociatedwith theresultsshouldbereturned.Canbeyesorno.Thedefault isno. StringOptional.Whethertoreturnthesymboliclinktotheentry ortheentryitself.Canbeyes/no.Thedefaultisyes,which returnstheentrytowhichthelinkpoints.
returnObjects
dereferenceLinks
Output Parameters connectionHandle results Usage Notes Toseeifnomatchwasfound,checkforanemptyresultsparameter. Object Optional.Thereturnedconnectionobject.Returnedonlyif thecloseparameterissettono. Record Thereturnedresultsofthesearch.
pub.client:smtp
WmPublic.SendsaMIMEtypeemailmessage. Youmayattachoneormorecontentobjectsorfilestothemessage. Input Parameters to cc bcc subject subjectCharset StringReceiversemailaddress.Ifyouspecifymultipleaddresses, separatethemwithcommas. StringOptional.Additionalreceiversemailaddresses.Ifyou specifymultipleaddresses,separatethemwithcommas. StringOptional.Additionalreceiversemailaddresses.Ifyou specifymultipleaddresses,separatethemwithcommas. StringSubjectofthemessage. StringOptional.ThecharactersetusedtoencodetheMIME messageheaders(includingsubject).IfsubjectCharsetisnot specified,thencharsetisused.Ifcharsetisnotspecified,thevaluein theserverparameterwatt.server.email.charsetisused.Ifthat parameterisnotset,theutf-8encodingisused. StringOptional.Thecharacterencodingofthebodytext.Ifcharsetis notspecified,thevalueintheserverparameter watt.server.email.charsetisused.Ifthatparameterisnotset,the utf-8encodingisused.
charset
87
3 Client Folder
from mailhost mailhostPort
StringSendersemailaddress. StringSMTPhostnameforoutboundmessages.Forexample:
smtp.webMethods.com
StringOptional.ThenumberoftheportonwhichtheSMTPhost listens.Thisparameterdoesnotneedtobesetifthehostlistenson port25(thestandardSMTPport). DocumentOptional.AuthorizationinformationthattheSMTP servicewillsubmit. Key user pass Description StringUsernamethatthisservicewillsubmitwhen requestingaprotectedresource. StringPasswordassociatedwithuser.
auth
body mimeStream
StringThecontentofthemessage. java.io.InputStreamOptional.MIMEorS/MIMEmessagethatyou wanttosendintheemail.AmimeStreamiscreatedbythe pub.mime:getEnvelopeStream,pub.smime:createEncryptedData,or pub.smime:createSignedDataservices.Itcontainsbothheadersand content.IfthemimeStreamalreadycontainsthefrom,to,andsubject headers,youdonotneedtopassthemasindividualinputstothis service. Document List Optional.Attachmentstothemessage.Each attachmentdefinesonemessagepartinamultipartmessage. Key contenttype content filename encoding Description StringMIMEtypeofthemessage.Forexample:
application/x-edi-message
attachments
byte[ ], String, or java.io.InputStreamContentofthe message. StringNameofalocalfiletobeattachedtothe message.Usedonlyifcontentisnotspecified. StringOptional.Encodingofthemessage.For example:base64or7bit.Ifencodingisnotspecified, 7bitisused. StringOptional.Charactersetencodingofthe attachment.ThisvalueisaddedtotheContentType headerfortheattachment.Ifcharsetisnotspecified, thevalueintheserverparameter watt.server.email.charsetisused.Ifthatparameter isnotset,theutf-8encodingisused.
charset
88
3 Client Folder
Output Parameters status Usage Notes Ifyouareusingfilenametoattachafiletothemessageandthefileisnotaplaintext file,youmustsetthecontenttypeandencoding.Forexample,toattach IntegrationServer_directory\mydir\myfile.doctoapub.client:smtpservice,youwould invoketheservicewiththefollowingvaluesinattachments: contenttype:application/msword filename:mydir/myfile.doc encoding:base64 StringFinalstatusofservice.
pub.client:soapClient
WmPublic.CreatesandsendsSOAP1.1andSOAP1.2messagesoverHTTPorHTTPS transportsforanystyle/usecombinationsupportedbyIntegrationServer.Thisisthe serviceusedbyallWebserviceconnectors. Input Parameters address StringStringspecifyingthenumericaddressornameofthe serveronwhichtheremoteprocedureresides.Ifyouare submittingtherequesttoawebMethodsIntegrationServer, remembertodirectittothedefaultSOAPprocessor(ws)as showninthefollowingexample:
http://rubicon:5555/soap/ws/example:calculator
request
DocumentTheinputparametersthataretobepassedtothe remoteprocedure.Forexample,ifyouwantedtopassthree Stringparameters,acct,amt,andorg,containingthevalues Cash,150.00,andSales,requestwouldcontainthefollowing: Key acct amt org Value

Cash 150.00 Sales
soapHeaders method
HeaderdocumentsincludedintheSOAPrequest. DocumentTheQNameoftherequestedprocedure.Thename isdefinedasfollows:
89
3 Client Folder
Key namespaceName localName auth
Value StringNamespaceportionofthe proceduresQName. StringLocalportionoftheprocedures QName.
DocumentOptional.Parametersspecifyingthecredentialsthat aretobesubmittedtotheserverspecifiedinaddress. IntegrationServernowallowstwolevelsofauthorization credentials,transportlevelandmessagelevel.Eachelementis definedasfollows: Parameter transport Description Transportlevelauthorizationparameters. Formoreinformationabouttheserver certificatekeysandWebservicesecurity, seetheWebServicesDevelopersGuide. Key type user Description StringTypeofauthentication thattheservicewillperform. StringUsernamethatthis servicewilluseifoneis requested. StringPasswordthatthis servicewillsubmitifoneis requested. privateKeyObjectTheSOAP messagesignersprivatekey. certChainObject ListAlist containingthesigners completecertificatechain, whereelement0inthelist containsthesigners certificateandelement1 containstheCAscertificate.
pass
serverCerts
90
3 Client Folder
message
Messagelevelauthorizationparameters. Formoreinformationabouttheserver certificatekeysandWebservicesecurity, seetheWebServicesDevelopersGuide. Key type user Description StringTypeofauthentication thattheservicewillperform. StringUsernamethatthis servicewilluseifoneis requested. StringPasswordthatthis servicewillsubmitifoneis requested. privateKeyObjectTheSOAP messagesignersprivatekey. certChainObject ListAlist containingthesigners completecertificatechain, whereelement0inthelist containsthesigners certificateandelement1 containstheCAscertificate. parnerCerts Thepartnerscomplete certificatechain,where element0inthelistcontains themessagesigners certificateandelement1 containstheCAscertificate.
pass
serverCerts
wsdName wsdBinderName wsdOperationName targetInputSignature targetOutputSignature
StringThenameoftheWebservicedescriptordefiningthis Webservice. StringThenameofabinderintheWebservicedescriptor,tobe used. StringThenameofanoperationinthebinder,tobeinvoked. StringOptional.FullyqualifiednameoftheISdocumenttype tousetovalidateandencodethecontentsofrequest. StringOptional.FullyqualifiednameoftheISdocumenttype tousetovalidateanddecodetheoutputvaluereturnedbythe remoteprocedure.
91
3 Client Folder
timeout
StringOptional.Time(measuredinmilliseconds)towaitfora responsefromtheserverhostingtheremoteprocedurebefore timingoutandterminatingtherequest.Thedefaultvalueisto waitforever. StringOptional.Valuetowhichyouwanttosetthe SOAPActionHTTPheader. String Optional.IndicatestheSOAPprotocoltheserviceuses tosendmessages.ValidvaluesareSOAP 1.1orSOAP 1.2. StringOptional.Specifiestheencodingmethod.Defaultvalue isUTF-8.
soapAction soapProtocol encoding Output Parameters soapResponseData response
ObjectASOAPobjectcontainingtheSOAPresponsemessage returnedbytheserverspecifiedinaddress. DocumentOutputparametersreturnedbytheremoteprocedure. Forexample,iftheremoteprocedurereturnedtwoString parameters,statusandbalance,containingthevaluesclosedand 4.95,responsewouldcontainthefollowing: Key status balance Value
closed -4.95
header
DocumentConditional.HeadersfromtheHTTPresponse.Will containthefollowingkeys: Key lines Value DocumentHeaderfieldsfromtheHTTPresponse. Eachkeyinlinesrepresentsafield(line)ofthe responseheader.Keynamesrepresentthenamesof headerfields.ThekeysvaluesareStrings containingthevaluesofthefields. StringStatuscodefromtheHTTPresponse.
status
statusMessage StringStatusmessagefromtheHTTPresponse.
92
3 Client Folder
soapStatus
StringFlagindicatingwhethertheSOAPrequestmessagewas processedsuccessfully. A value of...

0
Indicates that... TheremoteserversuccessfullyprocessedtheSOAP requestandreturnedaSOAPresponsemessage. TheremoteserverreturnedaSOAPfault,indicating thattheSOAPrequestwasreceivedbutwasnot processedsuccessfully. TheserverreturnedanerrorthatwasnotaSOAP fault.ThisindicatesthatsometypeofHTTPerror occurred(often,anHTTP404).Youcancheckthe statusfieldinheadertodeterminethetypeofHTTP errorthatoccurred.
Usage Notes Iftheaddressbeginswithhttps:,youmustspecifyaprivatekeyandcertificatechain. Youcanusetheauth.transport.serverCertsparameterstodoso.Ifyoudonotspecifythem usingtheauth.transport.serverCertsparameters,pub.client:soapClientusesthewebservice endpointaliasspecifiedinthebinder.Iftheendpointaliasdoesnothavean associatedprivatekeyandcertificatechain,thenthedefaultoutboundSSLcertificate settingsareusedtoauthenticatetheresources. See Also pub.client:soapHTTP pub.client:soapRPC
pub.client:soapHTTP
WmPublic.SubmitsaSOAPmessagetoaserverviaHTTPorHTTPS. Input Parameters soapRequestData ObjectSOAPmessagethatistobesent.Thisobjectmustbeproduced withtheservicesinthesoapfolder.SeeUsageNotesbelow. address StringURLtowhichyouwanttheSOAPmessagesent.Forexample:
https://servername:5555/soap/default
93
3 Client Folder
auth
DocumentOptional.Parametersspecifyingthecredentialsthatareto besubmittedtotheserverspecifiedinaddress.Eachelementisdefined asfollows: Key type Description StringTypeofauthenticationthattheservicewill perform.Leavethisfieldblank,astheonlyoption currentlyavailableisbasicHTTPauthentication. StringUsernamethatthisservicewilluseifoneis requested. StringPasswordthatthisservicewillsubmitifone isrequested.
user pass validateSOAP
StringOptional.Indicateswhetherornottheresponsemessageistobe validatedagainsttheSOAPschema. Set to...

true
To... Validatetheresponsemessageandthrowan exceptioniftheresponsedoesnotconformtothe SOAPschema. Default.Bypassthevalidationprocess.
false
SOAPAction
StringOptional.ValuetowhichyouwanttosettheSOAPActionHTTP header. Note: TheSOAPActionheaderwasrequiredbytheinitialSOAP specificationbuthassincebeendeprecated.TheIntegrationServer doesnotusetheSOAPActionheaderandacceptsSOAPmessagesthat omitit.Ifyouaredesigninganewsolution,werecommendthatyou avoidusingtheSOAPActionheader.However,ifyouexchangeSOAP messageswithsystemsthatrequireaSOAPActionheader,this parameterallowsyoutodoso.
contentType
StringOptional.SpecifiesthevalueofContentTypeintheHTTP header. Set to...

text/xml; charset=utf-8 text/xml
To... Default.SpecifythecontenttypeasXMLandthe characterencodingofthemessagetextasUTF8. SpecifythecontenttypeasXML.Sincethecharset parameterisnotspecified,thecharacterencoding ofthemessagetextdefaultstoUSASCII.
94
3 Client Folder
loadAs
StringOptional.SpecifiestheformatofthesoapResponseData.Default valueisstreamforanHTTPserviceandbyteArrayStreamforan HTTPSservice. Set to... stream To... DefaultforanHTTPservice.Returnthebodyof theresponseasajava.io.InputStream.Usethis optionwhenyouwillinvokeanHTTPWeb service. Returnthebodyoftheresponseasabyte[].Use thisoptionifthebodywillbeusedasinputtoa servicethatoperatesonwholeHTMLorXML documents(forexample,pub.xml:queryXMLNode). DefaultforanHTTPSservice.Havetheresponse streamfullyreadandconvertedto java.io.ByteArrayStream.Thispreventsdatalossor atruncatedSOAPresponseiftheconnectioncloses prematurely.Usethisoptionwhenyouwillinvoke anHTTPSWebservice.
bytes
byteArrayStream
timeout
StringOptional.Time(measuredinmilliseconds)towaitfora responsefromtheremoteserverbeforetimingoutandterminatingthe request.Thedefaultvalueistowaitforever.
Output Parameters soapResponseData header ObjectTheSOAPresponsemessagereturnedbytheserver specifiedinaddress. DocumentConditional.HeadersfromtheHTTPresponse.Will containthefollowingkeys: Key lines Description DocumentHeaderfieldsfromtheHTTPresponse. Eachkeyinlinesrepresentsafield(line)ofthe responseheader.Keynamesrepresentthenames ofheaderfields.ThekeysvaluesareStrings containingthevaluesofthefields. StringStatuscodefromtheHTTPresponse. StringStatusmessagefromtheHTTPresponse.
status statusMessage
95
3 Client Folder
soapStatus

0
Indicates that... Theremoteserversuccessfullyprocessedthe SOAPrequestandreturnedaSOAPresponse message. TheremoteserverreturnedaSOAPfault, indicatingthattheSOAPrequestwasreceived butwasnotprocessedsuccessfully. TheserverreturnedanerrorthatwasnotaSOAP fault.ThisindicatesthatsometypeofHTTPerror occurred(often,anHTTP404).Youcancheckthe statuselementinheadertodeterminethetypeof HTTPerrorthatoccurred.
Usage Notes Ifaddressbeginswithhttps:,youcanusepub.security:setKeyAndChaintospecifythe certificatechain.Ifyoudonotspecifyacertificatechain,pub.client:soapHTTPusesthe defaultoutboundSSLcertificatesettingstoauthenticatetheresources. TosendaSOAPmessagewiththisservice,youmustfirstgenerateanemptySOAP objectwiththepub.soap.utils:createSoapDataserviceandthenpopulateitusingservices suchaspub.soap.utils:addHeaderEntryandpub.soap.utils:addBodyEntry.Forinformationabout creatingandsendingSOAPmessages,seetheSOAPDevelopersGuide. See Also pub.client:soapRPC Examples sample.soap:buildMsg_sendHTTP
96
3 Client Folder
pub.client:soapRPC
WmPublic.SubmitsaSOAPremoteprocedurecallviaHTTPorHTTPS. Input Parameters address StringStringspecifyingthenumericaddressornameofthe serveronwhichtheremoteprocedureresides.Ifyouare submittingtherequesttoawebMethodsIntegrationServer, remembertodirectittotheRPCprocessorasshowninthe followingexample:
http://rubicon:5555/soap/rpc
reqParms
DocumentTheinputparametersthataretobepassedtothe remoteprocedure.Forexample,ifyouwantedtopassthree Stringparameters,acct,amt,andorg,containingthevalues Cash,150.00,andSales,reqParmswouldcontainthefollowing: Key acct amt org Value

Cash 150.00 Sales
method
DocumentTheQNameoftherequestedprocedurewhere: Key namespaceName localName Value StringNamespaceportionofthe proceduresQName. StringLocalportionoftheprocedures QName.
auth
DocumentOptional.Usernameandpasswordthataretobe submittedtotheserverspecifiedinaddress. Key type Value StringTypeofauthenticationthatthe servicewillperform.Leavethisfield blank,astheonlyoptioncurrently availableisbasicHTTPauthentication. StringUsernamethatthisservicewilluseif oneisrequested. StringPasswordthatthisservicewill submitifoneisrequested.
user pass targetInputSignature
StringOptional.FullyqualifiednameoftheISdocumenttype tousetovalidateandencodethecontentsofreqParms.
97
3 Client Folder
targetOutputSignature
StringOptional.FullyqualifiednameoftheISdocumenttype tousetovalidateanddecodetheoutputvaluereturnedbythe remoteprocedure. StringOptional.Valuetowhichyouwanttosetthe SOAPActionHTTPheader. Note: TheSOAPActionheaderwasrequiredbytheinitialSOAP specificationbuthassincebeendeprecated.IntegrationServer doesnotusetheSOAPActionheaderandacceptsSOAP messagesthatomitit.Ifyouaredesigninganewsolution,we recommendthatyouavoidusingtheSOAPActionheader. However,ifyouexchangeSOAPmessageswithsystemsthat requireaSOAPActionheader,thisparameterallowsyoutodo so.
SOAPAction
contentType
StringOptional.SpecifiesthevalueofContentTypeinthe HTTPheader. Set to...

text/xml; charset=utf-8
To... Default.SpecifythecontenttypeasXML andthecharacterencodingofthetextas UTF8. SpecifythecontenttypeasXML.Sincethe charsetparameterisnotspecified,the characterencodingofthetextdefaultsto USASCII.
text/xml
encoding
StringOptional.Specifiestheencodingmethod.Defaultvalue isUTF8.
98
3 Client Folder
loadAs
StringOptional.SpecifiestheformatofthesoapResponseData. Defaultvalueisstream. Set to... stream To... Default.Returnthebodyoftheresponseas ajava.io.InputStream.Usethisoption whenyouwillinvokeanHTTPWeb service. Havetheresponsestreamfullyreadand convertedtojava.io.ByteArrayStream.This preventsdatalossoratruncatedSOAP responseiftheconnectioncloses prematurely.Usethisoptionwhenyouwill invokeanHTTPSWebservice
byteArrayStream
timeout
StringOptional.Time(measuredinmilliseconds)towaitfora responsefromtheserverhostingtheremoteprocedurebefore timingoutandterminatingtherequest.Thedefaultvalueisto waitforever.
Output Parameters soapResponseData respParms ObjectASOAPobjectcontainingtheSOAPresponsemessage returnedbytheserverspecifiedinaddress. DocumentOutputparametersreturnedbytheremoteprocedure. Forexample,iftheremoteprocedurereturnedtwoString parameters,statusandbalance,containingthevaluesclosedand 4.95,respParmswouldcontainthefollowing: Key status balance header Value
closed -4.95
DocumentConditional.HeadersfromtheHTTPresponse.Will containthefollowingkeys: Key lines Value DocumentHeaderfieldsfromtheHTTPresponse. Eachkeyinlinesrepresentsafield(line)ofthe responseheader.Keynamesrepresentthenamesof headerfields.ThekeysvaluesareStrings containingthevaluesofthefields. StringStatuscodefromtheHTTPresponse.
status
statusMessage StringStatusmessagefromtheHTTPresponse.
99
3 Client Folder
soapStatus

0
Indicates that... TheremoteserversuccessfullyprocessedtheSOAP requestandreturnedaSOAPresponsemessage. TheremoteserverreturnedaSOAPfault,indicating thattheSOAPrequestwasreceivedbutwasnot processedsuccessfully. TheserverreturnedanerrorthatwasnotaSOAP fault.ThisindicatesthatsometypeofHTTPerror occurred(often,anHTTP404).Youcancheckthe statusfieldinheadertodeterminethetypeofHTTP errorthatoccurred.
Usage Notes Ifaddressbeginswithhttps:,youcanusepub.security:setKeyAndChaintospecifythe certificatechain.Ifyoudonotspecifyacertificatechain,pub.client:soapRPCusesthe defaultoutboundSSLcertificatesettingstoauthenticatetheresources. See Also pub.client:soapHTTP Examples sample.soap:buildRPC_SendHTTPSimple
100
Cluster Folder
Youusetheelementintheclusterfoldertoviewtheserversinacluster. Important! Theserviceinthisfolderhasbeendeprecated.
101
4 Cluster Folder

Thefollowingelementsareavailableinthisfolder: Element pub.cluster:getClusterHosts Package and Description WmPublic.DeprecatedReturnsalistofserversinthe cluster.
pub.cluster:getClusterHosts
WmPublic.DeprecatedReturnsalistofserversinthecluster. Input Parameters None. Output Parameters hosts Document List Conditional.Serversinthecluster. Key hostExternal hostAddress port sport Usage Notes ThehostExternaladdressmayormaynotbethesameashostAddress.ThehostAddress isusedtorefertotheserverfrominsidethefirewall,whilethehostExternaladdressis usedtorefertotheserverfromoutsideofthefirewall(suchaswhennetworkaddress translationisdoneatthefirewall). Description StringAddressoftheserverasknownoutsideofthe firewall. StringConfiguredIPaddressfortheserver. StringPrimaryHTTPport. StringPrimaryHTTPSport.
102
Date Folder
Youusetheelementsinthedatefoldertogenerateandformatdatevalues.
103
5 Date Folder

Thefollowingelementsareavailableinthisfolder: Element pub.date:dateBuild pub.date:dateTimeBuild pub.date:dateTimeFormat pub.date:formatDate pub.date:getCurrentDate pub.date:getCurrentDateString Pattern String Symbols Manyofthedateservicesrequireyoutospecifypatternstringsdescribingthedatas currentformatand/ortheformattowhichyouwantitconverted.Forservicesthat requireapatternstring,usethesymbolsinthefollowingtabletodescribetheformatof yourdata.Forexample,todescribeadateintheJanuary15,1999format,youwoulduse thepatternstringMMMMM dd, yyyy.Todescribetheformat01/15/99,youwouldusethe patternstringMM/dd/yy.Formoreinformationaboutthesepatternstringsymbols,seethe SunJavaAPIdocumentationfortheSimpleDateFormatclass. Symbol G y M d h H m s S E D F Meaning eradesignator year monthinyear dayinmonth hourinam/pm(112) hourinday(023) minuteinhour secondinminute millisecond dayinweek dayinyear dayofweekinmonth Presentation Text Number TextorNumber Number Number Number Number Number Number Text Number Number Example
AD 1996 or 96 July or Jul or 07 10 12 0 30 55 978 Tuesday or Tue 189 2 (2nd Wed in July)
Package and Description WmPublic.Buildsadate/timeStringusingthespecified patternandthespecifieddateelements. WmPublic.Buildsadate/timestringusingthespecified patternandthespecifieddateelements. WmPublic.Convertsdate/time(representedasaString) stringfromoneformattoanother. WmPublic.FormatsaDateobjectasastring. WmPublic.ReturnsthecurrentdateasaDateobject. WmPublic.ReturnsthecurrentdateasaStringina specifiedformat.
104
5 Date Folder
Symbol w W a k K z Z Time Zones
Meaning weekinyear weekinmonth am/pmmarker hourinday(124) hourinam/pm(011) timezone RFC822timezone(JVM 1.4orlater) escapefortext singlequote
Presentation Number Number Text Number Number Text Number Delimiter Literal
Example
27 2 PM 24 0 Pacific Standard Time or PST or GMT-08:00 -0800 (offset from GMT/UT)
'
Whenworkingwithdateservices,youcanspecifytimezones.TheEarthisdividedinto 24standardtimezones,oneforevery15degreesoflongitude.Usingthetimezone includingGreenwich,England(knownasGreenwichMeanTime,orGMT)asthestarting point,thetimeisincreasedbyanhourforeachtimezoneeastofGreenwichand decreasesbyanhourforeachtimezonewestofGreenwich.Thetimedifferencebetween atimezoneandthetimezoneincludingGreenwich,England(GMT)isreferredtoasthe rawoffset. ThefollowingtableidentifiesthedifferenttimezonesfortheEarthandtherawoffsetfor eachzonefromGreenwich,England.Theeffectsofdaylightsavingstimeareignoredin thistable. Note: GreenwichMeanTime(GMT)isalsoknownasUniversalTime(UT). ID MIT HST AST PST PNT MST CST EST IET Raw Offset 11 10 9 8 7 7 6 5 5 Name MidwayIslandsTime HawaiiStandardTime AlaskaStandardTime PacificStandardTime PhoenixStandardTime MountainStandardTime CentralStandardTime EasternStandardTime IndianaEasternStandardTime
105
5 Date Folder
ID PRT CNT AGT BET GMT ECT CAT EET ART EAT MET NET PLT IST BST VST CTT JST ACT AET SST NST Examples
Raw Offset 4 3.5 3 3 0 +1 +2 +2 +2 +3 +3.5 +4 +5 +5.5 +6 +7 +8 +9 +9.5 +10 +11 +12
Name PuertoRicoandU.S.VirginIslandsTime CanadaNewfoundlandTime ArgentinaStandardTime BrazilEasternTime GreenwichMeanTime EuropeanCentralTime CentralAfricaTime EasternEuropeanTime (Arabic)EgyptStandardTime EasternAfricanTime MiddleEastTime NearEastTime PakistanLahoreTime IndiaStandardTime BangladeshStandardTime VietnamStandardTime ChinaTaiwanTime JapanStandardTime AustralianCentralTime AustralianEasternTime SolomonStandardTime NewZealandStandardTime
Youcanspecifytimezoneinputparametersinthefollowingformats: Asafullname.Forexample:
Asia/Tokyo America/Los_Angeles
Youcanusethejava.util.TimeZone.getAvailableIDs()methodtoobtainalistofthe validfullnametimezoneIDsthatyourJVMversionsupports.
106
5 Date Folder
AsacustomtimezoneID,intheformatGMT[+|]hh[[:]mm].Forexample:
GMT+2:00
Alltimezones2hourseastofGreenwich(thatis,CentralAfrica Time,EasternEuropeanTime,andEgyptStandardTime) Alltimezones3hourswestofGreenwich(thatis,Argentina StandardTimeandBrazilEasternTime) Alltimezones9.5hourseastofGreenwich(thatis,Australian CentralTime)
GMT-3:00
GMT+9:30
Asathreeletterabbreviationfromthetableabove.Forexample:
PST
PacificStandardTime Note: Becausesomethreeletterabbreviationscanrepresentmultipletimezones (forexample,CSTcouldrepresentbothU.S.CentralStandardTimeand ChinaStandardTime),allabbreviationsaredeprecated.Usethefullnameor customtimezoneIDformatsinstead.
Notes on Invalid Dates Ifyouuseaninvaliddatewithadateservice,thedateserviceautomaticallytranslatesthe datetoalegaldate.Forexample,ifyouspecify1999/02/30asinput,thedateservice interpretsthedateas1999/03/02(twodaysafter2/28/1999). Ifyouuse00forthemonthorday,thedateserviceinterprets00asthelastmonthor dayintheGregoriancalendar.Forexample,ifyouspecify00forthemonth,thedate serviceinterpretsitas12. Ifthepatternyyisusedfortheyear,thedateserviceusesa50yearmovingwindowto interpretthevalueofyy.Thedateserviceestablishesthewindowbysubtracting49years fromthecurrentyearandadding50yearstothecurrentyear.Forexample,ifyouare runningthewebMethodsIntegrationServerintheyear2000,themovingwindowwould befrom1951to2050.Thedateserviceinterprets2digityearsasfallingintothiswindow (forexample,12wouldbe2012,95wouldbe1995).
107
5 Date Folder
pub.date:dateBuild
WmPublic.Buildsadate/timeStringusingthespecifiedpatternandthespecifieddate elements. Input Parameters pattern StringPatternrepresentingtheformatinwhichyouwantthedate returned.Forpatternstringnotation,seePatternStringSymbols onpage 104.Ifyoudonotspecifypattern,dateBuildreturnsnull.If patterncontainsatimezoneandtimezoneisnotspecified,the webMethodsIntegrationServersdefaulttimezoneisused. StringOptional.Theyearexpressedinyyyyoryyformat(for example,01or2001).Ifyoudonotspecifyyearoryouspecifyan invalidvalue,dateBuildusesthecurrentyear. StringOptional.Themonthexpressedasanumber(forexample,1 forJanuary,2forFebruary).Ifyoudonotspecifymonthoryou specifyaninvalidvalue,dateBuildusesthecurrentmonth. StringOptional.Thedayofthemonthexpressedasanumber(for example,1forthefirstdayofthemonth,2fortheseconddayofthe month).Ifyoudonotspecifydayofmonthoryouspecifyaninvalid value,dateBuildusesthecurrentday. StringOptional.Timezoneinwhichyouwanttheoutputdateand timeexpressed.SpecifyatimezonecodeasshowninTimeZones onpage 105(forexample,ESTforEasternStandardTime). Ifyoudonotspecifytimezone,thevalueoftheserversuser timezonepropertyisused.Ifthispropertyhasnotbeenset,GMTis used. locale StringOptional.Localeinwhichthedateistobeexpressed.For example,iflocaleisen(forEnglish),thepatternEEE d MMM yyyywill produceFriday 23 August 2002,andthelocaleoffr(forFrench)will producevendredi 23 aot 2002.
year
month
dayofmonth
timezone
Output Parameters value StringThedatespecifiedbyyear,month,anddayofmonth,inthe formatofpattern.
108
5 Date Folder
pub.date:dateTimeBuild
WmPublic.Buildsadate/timestringusingthespecifiedpatternandthespecifieddate elements. Input Parameters pattern StringPatternrepresentingtheformatinwhichyouwantthetime returned.Forpatternstringnotation,seePatternStringSymbols onpage 104.Ifyoudonotspecifypattern,dateTimeBuildreturnsnull.If patterncontainsatimezoneandthetimezoneparameterisnotset,the webMethodsIntegrationServerstimezoneisused. StringOptional.Theyearexpressedinyyyyoryyformat(for example,01or2001).Ifyoudonotspecifyyearoryouspecifyan invalidvalue,dateTimeBuildusesthecurrentyear. StringOptional.Themonthexpressedasanumber(forexample,1 forJanuary,2forFebruary).Ifyoudonotspecifymonthoryou specifyaninvalidvalue,dateTimeBuildusesthecurrentmonth. StringOptional.Thedayofthemonthexpressedasanumber(for example,1forthefirstdayofthemonth,2fortheseconddayofthe month).Ifyoudonotspecifydayofmonthoryouspecifyaninvalid value,dateTimeBuildusesthecurrentday. StringOptional.Thehourexpressedasanumberbasedona24hour clock(forexample,0 formidnight,2for2am,14for2pm).Ifyoudo notspecifyhouroryouspecifyaninvalidvalue,dateTimeBuilduses0 asthehourvalue. StringOptional.Minutesexpressedasanumber.Ifyoudonot specifyminuteoryouspecifyaninvalidvalue,dateTimeBuilduses0as theminutevalue. StringOptional.Secondsexpressedasanumber.Ifyoudonot specifysecondoryouspecifyaninvalidvalue,dateTimeBuilduses0as thesecondvalue. StringOptional.Millisecondsexpressedasanumber.Ifyoudonot specifymillisoryouspecifyaninvalidvalue,dateTimeBuilduses0as themillisvalue.
year
month
dayofmonth
hour
minute
second
millis
109
5 Date Folder
timezone
StringOptional.Timezoneinwhichyouwanttheoutputdateand timeexpressed.SpecifyatimezonecodeasshowninTimeZones onpage 105(forexample,ESTforEasternStandardTime). Ifyoudonotspecifytimezone,thevalueoftheserversuser timezonepropertyisused.Ifthispropertyhasnotbeenset,GMTis used.
locale
StringOptional.Localeinwhichthedateistobeexpressed.For example,iflocaleisen(forEnglish),thepatternEEE d MMM yyyy will produceFriday 23 August 2002,andthelocaleoffr(forFrench)will producevendredi 23 aot 2002.
Output Parameters value StringDateandtimeinformatofpattern.
pub.date:dateTimeFormat
WmPublic.Convertsdate/time(representedasaString)stringfromoneformatto another. Input Parameters inString StringDate/timethatyouwanttoconvert. Important! IfinStringcontainsacharacterinthelastposition,that characterisinterpretedas0.Thiscanresultinaninaccuratedate. Forinformationaboutinvaliddates,seepage 107. currentPattern newPattern StringPatternstringthatdescribestheformatofinString.For patternstringnotation,seePatternStringSymbolsonpage 104. StringPatternstringthatdescribestheformatinwhichyouwant inStringreturned.Forpatternstringsyntax,seePatternString Symbolsonpage 104. StringOptional.Localeinwhichthedateistobeexpressed.For example,iflocaleisen(forEnglish),thepatternEEE d MMM yyyywill produceFriday 23 August 2002,andthelocaleoffr(forFrench)will producevendredi 23 aot 2002.
locale
Output Parameters value StringThedate/timegivenbyinString,intheformatofnewPattern.
110
5 Date Folder
Usage Notes AsdescribedinNotesonInvalidDatesonpage 107,ifthepatternyyisusedforthe year,dateTimeFormatusesa50yearmovingwindowtointerpretthevalueoftheyear.If youneedtochangethisbehaviorsothattheyearisinterpretedas80yearsbeforeor 20yearsafterthecurrentdate(asdescribedintheJavaclass java.text.SimpleDateFormat),settheserverconfigurationparameter watt.server.pubDateTimeFormat.javaSlidingWindowtotrue.Forinformationabout settingconfigurationparameters,seethewebMethodsIntegrationServerAdministrators Guide. Bydefault,theIntegrationServerthrowsanexceptionifnoinputispassedtothe service.Tosuppresstheerrormessageandreturnanullvalueforthevalueparameter, settheserverconfigurationparameterwatt.server.date.suppressPatternErrorto true.Forinformationaboutsettingconfigurationparameters,seethewebMethods IntegrationServerAdministratorsGuide. IfcurrentPatterndoesnotcontainatimezone,thevalueisassumedtobeinthetime zoneofthewebMethodsIntegrationServer. IfnewPatterncontainsatimezone,thetimezoneofthewebMethodsIntegration Serverisused.
pub.date:formatDate
WmPublic.FormatsaDateobjectasastring. Input Parameters date pattern java.util.DateOptional.Date/timethatyouwanttoconvert. StringPatternstringthatdescribestheformatinwhichyouwantthe datereturned.Forpatternstringnotation,seePatternString Symbolsonpage 104. StringOptional.Timezoneinwhichyouwanttheoutputdateand timeexpressed.SpecifyatimezonecodeasshowninTimeZones onpage 105(forexample,ESTforEasternStandardTime). Ifyoudonotspecifytimezone,thevalueoftheserversuser timezonepropertyisused.Ifthispropertyhasnotbeenset,GMTis used. locale StringOptional.Localeinwhichthedateistobeexpressed.For example,iflocaleisen(forEnglish),thepatternEEE d MMM yyyywill produceFriday 23 August 2002,andthelocaleoffr(forFrench)will producevendredi 23 aot 2002.
timezone
Output Parameters value StringThedate/timegivenbydateintheformatspecifiedbypattern.
111
5 Date Folder
pub.date:getCurrentDate
WmPublic.ReturnsthecurrentdateasaDateobject. Input Parameters None. Output Parameters date java.util.DateCurrentdate.
pub.date:getCurrentDateString
WmPublic.ReturnsthecurrentdateasaStringinaspecifiedformat. Input Parameters pattern StringPatternrepresentingtheformatinwhichyouwantthedate returned.Forpatternstringnotation,seePatternStringSymbols onpage 104. StringOptional.Timezoneinwhichyouwanttheoutputdateand timeexpressed.SpecifyatimezonecodeasshowninTimeZones onpage 105(forexample,ESTforEasternStandardTime). Ifyoudonotspecifytimezone,thevalueoftheserversuser timezonepropertyisused.Ifthispropertyhasnotbeenset,GMTis used. locale StringOptional.Localeinwhichthedateistobeexpressed.For example,iflocaleisen(forEnglish),thepatternEEE d MMM yyyywill produceFriday 23 August 2002,andthelocaleoffr(forFrench)will producevendredi 23 aot 2002.
timezone
Output Parameters value StringCurrentdateintheformatspecifiedbypattern.
112
Db Folder
YouusetheelementsinthedbfoldertoaccessJDBCenableddatabases. Note: ThewebMethodsJDBCAdapteralsoprovidesservicesthatperformoperations againstJDBCenableddatabases.SeetheJDBCAdapterUsersGuideforinformation.
113
6 Db Folder

Thefollowingelementsareavailableinthisfolder: Element pub.db:call Package and Description WmDB.Invokesastoredprocedureonatargetdatabase.As analternativetothisservice,considerusingtheservices providedwiththewebMethodsJDBCAdapter. WmDB.Clearsthetransactionalstatewithinadatabase connection.Asanalternativetothisservice,considerusing theservicesprovidedwiththewebMethodsJDBCAdapter. WmDB.Closesaspecifieddatabaseconnection.Asan alternativetothisservice,considerusingtheservices providedwiththewebMethodsJDBCAdapter. WmDB.Closesalldatabaseconnectionsthatthesessionhas opened.Asanalternativetothisservice,considerusingthe servicesprovidedwiththewebMethodsJDBCAdapter. WmDB.Commitschangestoadatabase.Asanalternativeto thisservice,considerusingtheservicesprovidedwiththe webMethodsJDBCAdapter. WmDB.Createsaconnectiontothedatabaseusingthe suppliedJDBCURL,username,andpassword.Asan alternativetothisservice,considerusingtheservices providedwiththewebMethodsJDBCAdapter. WmDB.Removesallrowsinthespecifiedtablethatmeetthe givencriteria.Asanalternativetothisservice,considerusing theservicesprovidedwiththewebMethodsJDBCAdapter. WmDB.ExecutesthespecifiedSQLstatement.Asan alternativetothisservice,considerusingtheservices providedwiththewebMethodsJDBCAdapter. WmDB.Retrievesinformationaboutoneormorestored procedures.Asanalternativetothisservice,considerusing theservicesprovidedwiththewebMethodsJDBCAdapter. WmDB.Retrievesthenamesofstoredproceduresforthe specifieddatabase.Asanalternativetothisservice,consider usingtheservicesprovidedwiththewebMethodsJDBC Adapter. WmDB.Retrievesinformationaboutcolumnsinthespecified table.Asanalternativetothisservice,considerusingthe servicesprovidedwiththewebMethodsJDBCAdapter.
pub.db:clearTransaction
pub.db:close
pub.db:closeAll
pub.db:commit
pub.db:connect
pub.db:delete
pub.db:execSQL
pub.db:getProcInfo
pub.db:getProcs
pub.db:getTableInfo
114
6 Db Folder
Element pub.db:getTables
Package and Description WmDB.Retrievesthenamesoftablesinthespecified databaseandschema.Asanalternativetothisservice, considerusingtheservicesprovidedwiththewebMethods JDBCAdapter. WmDB.Insertsoneormorerowsintothespecifiedtable.As analternativetothisservice,considerusingtheservices providedwiththewebMethodsJDBCAdapter. WmDB.Retrievesallrowsfromthespecifiedtablethatmeet thegivencriteria.Asanalternativetothisservice,consider usingtheservicesprovidedwiththewebMethodsJDBC Adapter. WmDB.Discardschangestoadatabase.Asanalternativeto thisservice,considerusingtheservicesprovidedwiththe webMethodsJDBCAdapter. WmDB.Beginsatransactiononadatabaseconnection.Asan alternativetothisservice,considerusingtheservices providedwiththewebMethodsJDBCAdapter. WmDB.Updatesallrowsinatablethatmeetthegiven criteria.Rowsareupdatedwiththesuppliednewdata.Asan alternativetothisservice,considerusingtheservices providedwiththewebMethodsJDBCAdapter.
pub.db:insert
pub.db:query
pub.db:rollback
pub.db:startTransaction
pub.db:update
pub.db:call
WmDB.Invokesastoredprocedureonatargetdatabase.Asanalternativetothis service,considerusingtheservicesprovidedwiththewebMethodsJDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL StringOptional.Aliasofthedatabaseonwhichyouwantto executethestoredprocedure. StringOptional.JDBCURLthatidentifiesthedatabaseresource.
115
6 Db Folder
$dbUser $dbPass $dbDriver $dbConnection $dbCatalog
StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuserspecifiedin$dbUser. StringOptional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect. StringOptional.Nameofthedatabasessystemcatalog.Include thisparameterifyourDBMSsupportsdistributeddatabasesand youwanttoinvokeastoredprocedurefromadatabaseother thantheonetowhichyouareconnected. Ifyouarenotusingadistributeddatabasesystem,youdonot needtospecifythisparameter. IfyouarerunningagainstDB2,usethisparametertospecifythe storedprocedureslocation.
$dbSchemaPattern
StringOptional.Nameoftheschematowhichthestored procedurebelongs. Ifyourdatabasesupportspatternmatchingonschemas,you mayspecifytheschemanamewithapatternmatchingstring, where_representsasinglecharacterand%representsany stringofcharacters.Forexample,thevalueofHR%would representanyschemabeginningwithcharactersHR. IfyouarerunningagainstDB2,youusethisparameterto specifythestoredproceduresAuthID.
$dbProc $dbProcSig
StringThenameofthestoredprocedureyouwanttoinvoke. Document ListOptional.Setofparameterscontaining informationaboutthestoredprocedureyouwanttoinvoke. Key name sqlType Description StringParameternamedefinedinthestored procedure. StringTypeofprocedureparameterfornameas definedinthedatabase.Settooneofthefollowing values:
BIT SMALLINT BiGINT REAL NUMBERIC CHAR LONGVARCHAR TIME BINARY LONGVARBINARY TINYINT INTEGER FLOAT DOUBLE DECIMAL VARCHAR DATE TIMESTAMP VARBINARY NULL
116
6 Db Folder
direction
StringWayinwhichtheparameterisusedbythe storedprocedure.Settooneofthefollowingvalues:
in out inout return value
$dbParamsByOrder
StringOptional.Indicateswhetherthecontentsof$datashould besenttothedatabaseinorder. Set to...

true
To... Sendthecontentsof$datatothedatabaseintheorder theyarelistedin$data. Default.Sendthecontentsof$datatothedatabasein noparticularorder.
false
$data Output Parameters $dbMessage Usage Notes
Document Optional.Parametervaluesforthestoredprocedure.
StringConditional.Messageindicatingthesuccessorfailureof theoperation.
Theoutputwillalsocontainoutputparametersandprocedurereturnvalues(the returnvalueiscalledRETURN_VALUE).
117
6 Db Folder
pub.db:clearTransaction
WmDB.Clearsthetransactionalstatewithinadatabaseconnection.Asanalternativeto thisservice,considerusingtheservicesprovidedwiththewebMethodsJDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias StringOptional.Aliasofthedatabaseconnectiononwhichyouwant toclearthetransactionalstate.Thealiasispassedautomaticallyifthe databaseisconnected. StringOptional.JDBCURLthatidentifiesthedatabaseresource. StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuser. StringOptional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect.
$dbURL $dbUser $dbPass $dbDriver $dbConnection Output Parameters $dbMessage Usage Notes
StringAmessageindicatingthesuccessorfailureoftheoperation.
Onsomedatabases,exceptionalconditionswithintransactionswillautomatically aborttheentiretransaction.Whenthishappens,thestandardcommit/rollback operationsaremeaninglessbecausethereisnocurrenttransaction.Ifthisoccurs,use theclearTransactionservicetoclearthetransactionalstateandprepareforanew transaction.Youshouldonlyusethisserviceifyouhavebegunatransactionand cannotenditwithastandardcommitorrollback. TheclearTransactionservicedoesnotinvolveadatabaseoperation;itisentirelyinternal tothewebMethodsIntegrationServer.
118
6 Db Folder
pub.db:close
WmDB.Closesaspecifieddatabaseconnection.Asanalternativetothisservice, considerusingtheservicesprovidedwiththewebMethodsJDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser $dbPass $dbDriver $dbConnection $closeDbConnection StringOptional.Databasealias. StringOptional.JDBCURLthatidentifiesthedatabase resource. StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuser. StringOptional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect. StringOptional.Indicateswhethertoremovethedatabase connectionfromthepoolorreturnittothepoolforfutureuse. Set to...
true false
To... Closetheconnectionandremoveitfromthepool. Default.Closetheconnectionandreturnittothe poolforfutureuse.
Output Parameters $dbMessage StringMessageindicatingthesuccessorfailureoftheoperation.
119
6 Db Folder
pub.db:closeAll
WmDB.Closesalldatabaseconnectionsthatthesessionhasopened.Asanalternativeto thisservice,considerusingtheservicesprovidedwiththewebMethodsJDBCAdapter. Input Parameters None. Output Parameters $dbMessage StringMessageindicatingthesuccessorfailureoftheoperation.
pub.db:commit
WmDB.Commitschangestoadatabase.Asanalternativetothisservice,considerusing theservicesprovidedwiththewebMethodsJDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias StringOptional.Aliasofthedatabaseonwhichyouwanttocommit changes.Thealiasispassedautomaticallyifthedatabaseis connected. StringOptional.JDBCURLthatidentifiesthedatabaseresource. StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuser. StringOptional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect.
$dbURL $dbUser $dbPass $dbDriver $dbConnection Output Parameters $dbMessage
StringMessageindicatingthesuccessorfailureoftheoperation.
120
6 Db Folder
Usage Notes Thisservicereturnsanexceptionifanerroroccurswhencommittingchangestothe database.Themostcommonreasonforthiserroristhatnotransactionhasbeen started(seepub.db:startTransaction).
pub.db:connect
WmDB.CreatesaconnectiontothedatabaseusingthesuppliedJDBCURL,username, andpassword.Asanalternativetothisservice,considerusingtheservicesprovidedwith thewebMethodsJDBCAdapter. YoucanalsospecifyaJDBCdriverspecifictothedatabase. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbURL,$dbDriver,$dbProperties $dbAlias $dbURL $dbUser $dbPass $dbDriver $dbProperties StringOptional.Databasealias. StringOptional.JDBCURLthatidentifiesthedatabaseresource. StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuser. StringOptional.NameoftheJDBCdrivertouse. Document Optional.Setofconnectionparametersthataretobeused tomakethedatabaseconnection.Within$dbProperties,keynames representthenamesoftheconnectionparametersthataretobeused toestablishtheconnection,andthevalueofakeyspecifiesthevalue ofthatparticularparameter. Inmostcases,youwillincludethekeysuserandpasswordin $dbPropertiestospecifytheusernameandpasswordparametersthat aretobeusedtoconnecttothedatabase.Youmayinclude additionalparametersasneeded. Thefollowingexampleshowshow$dbPropertieswouldlookifyou wantedtosettheweblogic.codesetparametertoGBKinordertoextract Unicodedataoutofthedatabase:
121
6 Db Folder
Key user password weblogic.codeset Output Parameters $dbConnection $dbMessage Usage Notes
Value
dbu dbu GBK
com.wm.app.b2b.server.DBConnectionConnectionobject. String Messageindicatingthesuccessorfailureoftheoperation.
Databaseconnectionsopenedbypub.db:connectareassociatedwiththecurrentsession. Multipleattemptstoconnecttothesamedatabasebythesameclientwillresultinthe sameconnectionbeingreused.ThismeansthatifclientAandclientBrequest connectionstothesamedatabase,theyeachgettheirownnewconnection.IfclientA makesanothercalltopub.db:connect,thepreviousconnectionisreused.Associatingthe databaseconnectionwiththeclientsessionpreventsremoteclientsfromhavingto reconnectrepeatedlytoatargetdatabase. Connectionsarenotpooledorsharedacrosssessions.Unlessexplicitlyclosed(by callingpub.db:closeorpub.db:closeAll),connectionsassociatedwithasessionareclosed whenthesessionisflushedfrommemory.Thishappensataregularinterval,which canbeconfiguredusingtheIntegrationServerAdministrator.Formoreinformation aboutsettingthesessiontimeoutlimit,seethewebMethodsIntegrationServer AdministratorsGuide.
122
6 Db Folder
pub.db:delete
WmDB.Removesallrowsinthespecifiedtablethatmeetthegivencriteria.Asan alternativetothisservice,considerusingtheservicesprovidedwiththewebMethods JDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser $dbPass $dbDriver $dbConnection $dbCatalog String Optional.Databasealias. String Optional.JDBCURLthatidentifiesthedatabaseresource. String Optional.Usernametousetologintothedatabase. String Optional.Passwordfortheuser. String Optional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect. String Optional.Nameofthedatabasessystemcatalog.Include thisparameterifyourDBMSsupportsdistributeddatabasesand youwanttodeleterowsfromatablethatisnotinthedatabaseto whichyouareconnected. Ifyouarenotusingadistributeddatabasesystemorifyouwant todeleterowsfromthedatabasetowhichyouareconnected,you donotneedtospecifythisparameter. IfyouarerunningagainstDB2,usethisparametertospecifythe databaselocation. $dbSchemaPattern StringOptional.Nameoftheschematowhichthetablebelongs. Ifyourdatabasesupportspatternmatchingonschemas,youmay specifytheschemanamewithapatternmatchingstring,where_ representsasinglecharacterand%representsanystringof characters.Forexample,thevalueHR%wouldrepresentany schemabeginningwiththecharactersHR. IfyouarerunningagainstDB2,youusethisparametertospecify thetablesAuthID.
123
6 Db Folder
$dbTable $data
StringNameofthetabletoremoverowsfrom. DocumentOptional.Criteriathattherowstodeletemustmeet. Important! Ifnocriteriaareprovided,allrowsaredeletedfromthe table.
Output Parameters $updateCount $dbMessage StringNumberofrowsdeleted. String Conditional.Messageindicatingthesuccessorfailureofthe operation.
pub.db:execSQL
WmDB.ExecutesthespecifiedSQLstatement.Asanalternativetothisservice,consider usingtheservicesprovidedwiththewebMethodsJDBCAdapter. TheservicedoesnotperformanyparsingontheSQLstatement. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser $dbPass $dbDriver $dbConnection String Optional.Databasealias. String Optional.JDBCURLthatidentifiesthedatabase resource. String Optional.Usernametousetologintothedatabase. String Optional.Passwordfortheuser. String Optional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connection objectreturnedbypub.db:connect.
124
6 Db Folder
$dbCatalog
String Optional.Nameofthedatabasessystemcatalog. IncludethisparameterifyourDBMSsupportsdistributed databasesandyouwanttoretrieveinformationfroma databasetowhichyouarenotcurrentlyconnected. Ifyouarenotusingadistributeddatabasesystem,youdo notneedtospecifythisparameter. IfyouarerunningagainstDB2,usethisparameterto specifythedatabaselocation.
$dbSchemaPattern
String Optional.Nameoftheschematowhichthetable belongs. Ifyourdatabasesupportspatternmatchingonschemas, youmayspecifytheschemanamewithapatternmatching string,where_representsasinglecharacterand% representsanystringofcharacters.Forexample,thevalue HR%wouldrepresentanyschemabeginningwiththe charactersHR. IfyouarerunningagainstDB2,youusethisparameterto specifythetablesAuthID.
$dbSQL $dbProcessEsc
StringSQLstatementtoexecute. StringOptional.FlagthatindicateswhetherJDBCSQL escapeswillbeprocessed.Theseescapesallowdatabase independentaccesstodatabasedependentfunctionality. Forexample,differentdialectsofSQLhavedifferent syntaxfordateliterals.UsingaJDBCescape,youcan encodeadateliteralinaSQLstringthatshouldworkon anydatabase.DocumentationonJDBCSQLescapesis widelyavailable. Set to...
true false
To... Default.ProcessJDBCSQLescapes. SkipprocessingJDBCSQLescapes.
$dbProcessReporterTokens
StringOptional.Flagthatindicateswhetherreportertags (forexample,%value xxx%)willbeprocessedintheSQL. IncludingthesetokensinyourSQLallowsdynamic constructionofcomplexSQLstatements,atthepossible expenseofsomeexecutionspeed. Set to...

true false
To... Processtags. Default.Ignoretags.
125
6 Db Folder
$dbParamValues
Object ListOptional.Ifthe?parametersintheSQL statementarenotsuppliedindirectly(withthe $dbParamNamesparameter),theycanbesupplieddirectly viathisparameter.SeeUsageNotesbelow.Objectsin $dbParamValuescanbeofanytype. String List Optional.Namesofany?parametersinthe SQL.SeeUsageNotesbelow. String List Optional.SQLtypenamesforeachparameter. UsetypenamesfromtheJDBC1.2specification( INTEGER,VARCHAR,etc.).
$dbParamNames $dbParamTypes
Output Parameters sql StringConditional.SQLasitwasactuallypassedtothe targetdatabase.Thiscanbehelpfulindebuggingcallsto thisservicewhendynamicSQLisused(thatis,youare usingeitherJDBCSQLescapesorwebMethodsReporter tokensinyourSQL). String List Conditional.Valuesusedforeachofthe parametersintheSQLstatement.Thiscanbehelpfulin debuggingcallstothisservicewhen?parametersare beingused. String Conditional.Numberofrowsinresults. com.wm.util.TableConditional.ResultsfromtheSQL statement.TheIntegrationServerrecognizesandtreats thisparameterasaDocumentListatruntime. String Conditional.Numberofrowsupdated. StringConditional.Messageindicatingthesuccessor failureoftheoperation.
paramsAsStrings
$rowCount results
$updateCount $dbMessage Usage Notes
ThisservicedoesnotsupportupdatesfromaWebbrowserorHTMLform. SQLsupportshostvariables(?)instatementstobeexecuted.Becausethepipeline isbasedonnamedvaluesandindividualhostvariablesarenotnamed, $dbParamNamesand$dbParamTypesareusedtosupplyanindextonamemappingfor eachSQLstatementexecuted.Forexample,considerthefollowingSQLquery:

SELECT * FROM royalties WHERE pub_id = ? and roy_amt > ?
ToexecutethisSQLquery,youcouldsupplythefollowingvaluestothe pub.db:execSQLservice:
126
6 Db Folder
Key $dbSQL
Value
SELECT * FROM royalties WHERE pub_id = ? and roy_amt > ? pub_id roy_amt varchar integer P1053 10
Description SQLquerytoexecute.
$dbParamNames $dbParamTypes pub_id roy_amt
Pipelineitemstouseforthehost variables. SQLtypesforthehostvariables. Valuesforthehostvariables. Valuesforthehostvariables.
Note: EvenifthereisonlyonehostvariableintheSQLstatement, both$dbParamNamesand$dbParamTypesareStringarrays. Example:ConsiderthefollowingSQLquery,whichcontainsanINSERTwiththreehost variables:

INSERT INTO books VALUES (?, ?, ?)
ToexecutethisSQLquery,youcouldsupplythefollowingvaluestothe pub.db:execSQLservice: Key $dbSQL $dbParamNames Value

INSERT INTO books VALUES (?, ?, ?) book_id pub_id book_title varchar varchar varchar B234 P1053 The Importance of Being Earnest
Description SQLquerytoexecute. Pipelineitemstouseforthehost variables. SQLtypesforthehostvariables.
$dbParamTypes
book_id pub_id book_title
Valuesforthehostvariables. Valuesforthehostvariables. Valuesforthehostvariables.
Note: TheSQLtypenamesusedintheexamplesaredefinedin thejava.sql.TypesandSQL92.EvenifyouusedanOracle database,whichcallslongstringtypesvarchar2,youwould callthemvarchar.ThestandardnamesfromSQL92willbe mappedintodatabasespecifictypenames.
127
6 Db Folder
pub.db:getProcInfo
WmDB.Retrievesinformationaboutoneormorestoredprocedures.Asanalternativeto thisservice,considerusingtheservicesprovidedwiththewebMethodsJDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser $dbPass $dbDriver $dbConnection $dbCatalog StringOptional.Databasealias. StringOptional.JDBCURLthatidentifiesthedatabaseresource. StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuser. StringOptional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect. StringOptional.Nameofthedatabasessystemcatalog.Include thisparameterifyourDBMSsupportsdistributeddatabasesand youwanttoretrieveinformationaboutastoredprocedurethatis notinthedatabasetowhichyouarecurrentlyconnected. Ifyouarenotusingadistributeddatabasesystem,youdonot needtospecifythisparameter. IfyouarerunningagainstDB2,usethisparametertospecifythe storedprocedureslocation. $dbSchemaPattern StringOptional.Nameoftheschematowhichthetablebelongs. Ifyourdatabasesupportspatternmatchingonschemas,youmay specifytheschemanamewithapatternmatchingstring,where_ representsasinglecharacterand%representsanystringof characters.Forexample,thevalueHR%wouldrepresentany schemabeginningwiththecharactersHR. IfyouarerunningagainstDB2,youusethisparametertospecify thestoredproceduresAuthID. $dbProc StringNameoftheprocedureaboutwhichyouwantinformation.
128
6 Db Folder
Output Parameters Thisservicereturnsonedocument(IDataobject)foreachiteminthestoredprocedures signaturethatmatchesthespecifiedinputcriteria.Eachdocumentcontainsinformation aboutthesignatureitem.Thedocumentskeywillbethesameasthesignatureitems name.Foradescriptionofwhatinformationissuppliedbyyourdatabase,see java.sql.DatabaseMetaData.getProcedureColumnsinyourJDBCdocumentation.
pub.db:getProcs
WmDB.Retrievesthenamesofstoredproceduresforthespecifieddatabase.Asan alternativetothisservice,considerusingtheservicesprovidedwiththewebMethods JDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser $dbPass $dbDriver $dbConnection $dbCatalog StringOptional.Databasealias. StringOptional.JDBCURLthatidentifiesthedatabase resource. StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuser. StringOptional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connection objectreturnedbypub.db:connect. StringOptional.Nameofthedatabasessystemcatalog. IncludethisparameterifyourDBMSsupportsdistributed databasesandyouwanttoretrievealistofstoredprocedures fromadatabaseotherthantheonetowhichyouare connected. Ifyouarenotusingadistributeddatabasesystem,youdonot needtospecifythisparameter. IfyouarerunningagainstDB2,usethisparametertospecify thedatabaselocation.
129
6 Db Folder
$dbSchemaPattern
StringOptional.Nameoftheschematowhichthestored proceduresbelong. Ifyourdatabasesupportspatternmatchingonschemas,you mayspecifytheschemanamewithapatternmatchingstring, where_representsasinglecharacterand%representsany stringofcharacters.Forexample,thevalueHR%would representanyschemabeginningwiththecharactersHR. IfyouarerunningagainstDB2,youusethisparameterto specifythedatabasesAuthID.
$dbProcNamePattern
StringOptional.Patternmatchingstringthatspecifiesthe proceduresthatyouwantincludedinthereturnedlist,where _representsasinglecharacterand%representsanystringof characters.Forexample,thevalueDATE%wouldrepresentany procedurebeginningwiththecharactersDATE.
Output Parameters Thisservicereturnsonedocument(IDataobject)foreachstoredprocedurethatmatches thespecifiedinputcriteria.Eachdocumentcontainsinformationaboutastored procedure.Thedocumentskeywillbethesameasthestoredprocedurename.Fora descriptionofwhatinformationissuppliedbyyourdatabase,see java.sql.DatabaseMetaData.getProceduresinyourJDBCdocumentation.
pub.db:getTableInfo
WmDB.Retrievesinformationaboutcolumnsinthespecifiedtable.Asanalternativeto thisservice,considerusingtheservicesprovidedwiththewebMethodsJDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser StringOptional.Databasealias. StringOptional.JDBCURLthatidentifiesthedatabase resource. StringOptional.Usernametousetologintothedatabase.
130
6 Db Folder
$dbPass $dbDriver $dbConnection $dbCatalog
StringOptional.Passwordfortheuser. StringOptional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connection objectreturnedbypub.db:connect. String Optional.Nameofthedatabasessystemcatalog. IncludethisparameterifyourDBMSsupportsdistributed databasesandyouwantinformationaboutatablethatisnot inthedatabasetowhichyouareconnected. Ifyouarenotusingadistributeddatabasesystemoryou wantinformationaboutatableinthedatabasetowhichyou areconnected,youdonotneedtospecifythisparameter. IfyouarerunningagainstDB2,usethisparametertospecify thedatabaselocation.
$dbSchemaPattern
String Optional.Nameoftheschematowhichthetable belongs. Ifyourdatabasesupportspatternmatchingonschemas,you mayspecifyapatternmatchingstringfortheschemaname, where_representsasinglecharacterand%representsany stringofcharacters.Forexample,thevalueHR%would representanyschemabeginningwiththecharactersHR. IfyouarerunningagainstDB2,youusethisparameterto specifythetablesAuthID.
$dbTable $dbColumnNamePattern
String Nameoftablewhosecolumnnamesyouwantto retrieve. String Optional.Patternmatchingstringthatspecifiesthe columnnamesthatyouwanttoretrieve,where_represents asinglecharacterand%representsanystringofcharacters. Forexample,thevalueADDR%wouldrepresentanycolumn namebeginningwiththecharactersADDR.
Output Parameters Thisservicereturnsonedocument(IDataobject)foreachcolumnthatmatchesthe specifiedinputcriteria.Eachdocumentcontainsinformationaboutacolumn.The documentskeywillbethesameasthecolumnname. Usage Notes ThisserviceacceptsinputfromaWebbrowserorHTMLform.
131
6 Db Folder
pub.db:getTables
WmDB.Retrievesthenamesoftablesinthespecifieddatabaseandschema.Asan alternativetothisservice,considerusingtheservicesprovidedwiththewebMethods JDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser $dbPass $dbDriver $dbConnection $dbCatalog String Optional.Databasealias. String Optional.JDBCURLthatidentifiesthedatabase resource. String Optional.Usernametousetologintothedatabase. String Optional.Passwordfortheuser. String Optional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect. String Optional.Nameofthedatabasessystemcatalog.Include thisparameterifyourDBMSsupportsdistributeddatabases andyouwantinformationfromadatabasethatisnottheoneto whichyouareconnected. Ifyouarenotusingadistributeddatabasesystemoryouwant informationaboutthedatabasetowhichyouareconnected, youdonotneedtospecifythisparameter. IfyouarerunningagainstDB2,usethisparametertospecify thedatabaselocation.
132
6 Db Folder
$dbSchemaPattern
String Optional.Nameoftheschemaforwhichyouwantthe namesoftables. Ifyourdatabasesupportspatternmatchingonschemas,you mayspecifyapatternmatchingstringfortheschemaname, where_representsasinglecharacterand%representsany stringofcharacters.Forexample,thevalueHR%wouldrepresent anyschemabeginningwiththecharactersHR. Ifyouwantthetablenamesfromallschemas,set $dbSchemaPatterntonull. IfyouarerunningagainstDB2,youusethisparameterto specifythetablesAuthID.
$dbTableNamePattern
String Optional.Patternstringdescribingthetableswhose namesyouwanttoretrieve. Ifyourdatabasesupportspatternmatchingonschemas,you mayspecifyapatternmatchingstring,where_representsa singlecharacterand%representsanystringofcharacters.For example,thevalueHR%wouldrepresentanytablename beginningwiththecharactersHR. Ifyouwantalltablenames,set$dbTableNamePatterntonull. String List Optional.Setofparametersspecifyingthetypesof tableswhosenamesyouwanttoretrieve.CommonJDBCtable typesinclude:TABLE,VIEW,SYSTEM TABLE,ALIAS,andSYNONYM. Checkyourdriverdocumentationforothers.
$dbTableTypeList
Output Parameters Thisservicereturnsonedocument(IDataobject)foreachtablethatmatchesthespecified inputcriteria.Eachdocumentcontainsinformationaboutatable.Thedocumentskey willbethesameasthetablename. Usage Notes ThisserviceacceptsinputfromaWebbrowserorHTMLform.
133
6 Db Folder
pub.db:insert
WmDB.Insertsoneormorerowsintothespecifiedtable.Asanalternativetothis service,considerusingtheservicesprovidedwiththewebMethodsJDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser $dbPass $dbDriver $dbConnection $dbCatalog StringOptional.Databasealias. StringOptional.JDBCURLthatidentifiesthedatabaseresource. StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuser. StringOptional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect. String Optional.Nameofthedatabasessystemcatalog.Include thisparameterifyourDBMSsupportsdistributeddatabasesand youwanttoinsertrowsintoatablethatisnotinthedatabaseto whichyouareconnected. Ifyouarenotusingadistributeddatabasesystemorifyouwant toinsertrowsintothedatabasetowhichyouareconnected,you donotneedtospecifythisparameter. IfyouarerunningagainstDB2,usethisparametertospecifythe databaselocation. $dbSchemaPattern StringOptional.Nameoftheschematowhichthetablebelongs. Ifyourdatabasesupportspatternmatchingonschemas,youmay specifytheschemanamewithapatternmatchingstring,where_ representsasinglecharacterand%representsanystringof characters.Forexample,thevalue HR%wouldrepresentany schemabeginningwiththecharactersHR. IfyouarerunningagainstDB2,youusethisparametertospecify thetablesAuthID. $dbTable StringNameoftableinwhichyouwanttoinsertrows.
134
6 Db Folder
$dbRollbackOnFail
StringOptional.Flagthatdeterminewhetherchangesare committedifafailureoccurswhileprocessingmultipleinserts. Set to...

true false
To... Undochangesonfailure. Default.Commitchangesonfailure.
$data Output Parameters $updateCount $failCount $errors $dbMessage Usage Notes
DocumentorDocument List Optional.Datatoinsert.
StringNumberofrowstheserviceinserted. StringNumberofrowstheservicefailedtoinsert. Document Conditional.Errormessagesgeneratedduringservice execution. StringConditional.Messageindicatingthesuccessorfailureofthe operation.
ThisserviceacceptsinputfromaWebbrowserorHTMLform.
pub.db:query
WmDB.Retrievesallrowsfromthespecifiedtablethatmeetthegivencriteria.Asan alternativetothisservice,considerusingtheservicesprovidedwiththewebMethods JDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser $dbPass StringOptional.Databasealias. StringOptional.JDBCURLthatidentifiesthedatabaseresource. StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuser.
135
6 Db Folder
$dbDriver $dbConnection $dbCatalog
String Optional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect. StringOptional.Nameofthedatabasessystemcatalog.Include thisparameterifyourDBMSsupportsdistributeddatabasesand youwanttoqueryatablethatisnotinthedatabasetowhich youareconnected. Ifyouarenotusingadistributeddatabasesystemorifyouwant toqueryatableinthedatabasetowhichyouareconnected,you donotneedtospecifythisparameter. IfyouarerunningagainstDB2,usethisparametertospecifythe databaselocation.
$dbSchemaPattern
StringOptional.Nameoftheschematowhichthetablebelongs. Ifyourdatabasesupportspatternmatchingonschemas,you mayspecifytheschemanamewithapatternmatchingstring, where_representsasinglecharacterand%representsanystring ofcharacters.Forexample,thevalueHR%wouldrepresentany schemabeginningwiththecharactersHR. IfyouarerunningagainstDB2,youusethisparameterto specifythetablesAuthID.
$dbTable $data Output Parameters results
StringNameoftabletoquery. Document Optional.Criteriathattherowstoretrievemustmeet.
com.wm.util.Table Conditional.Resultsofthequery.TheIntegration ServerrecognizesandtreatsthisparameterasaDocumentListat runtime. String Conditional.Messageindicatingthesuccessorfailureofan operation. String Conditional.Numberofrowsforthetablethatmeetthe criteriaspecifiedin$data.
$dbMessage $rowCount Usage Notes
ThisserviceacceptsinputfromaWebbrowserorHTMLform.
136
6 Db Folder
pub.db:rollback
WmDB.Discardschangestoadatabase.Asanalternativetothisservice,considerusing theservicesprovidedwiththewebMethodsJDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser $dbPass $dbDriver $dbConnection Output Parameters $dbMessage Usage Notes Thisservicethrowsanexceptionifanerroroccurswhendiscardingchangestothe database.Themostcommonreasonforthiserroristhatnotransactionhasbeen started(seepub.db:startTransaction). StringMessageindicatingthesuccessorfailureoftheoperation. StringOptional.Aliasofthedatabaseforwhichyouwanttodiscard changes.Thisinformationispassedautomatically. StringOptional.JDBCURLthatidentifiesthedatabaseresource. StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuser. StringOptional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect.
137
6 Db Folder
pub.db:startTransaction
WmDB.Beginsatransactiononadatabaseconnection.Asanalternativetothisservice, considerusingtheservicesprovidedwiththewebMethodsJDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser $dbPass $dbDriver $dbConnection Output Parameters $dbMessage Usage Notes Bydefault,alldatabaseconnectionsareopenedinautocommitmode,meaningthe resultsofaoperationareautomaticallycommittedtothedatabasewhenthat operationsucceeds.Touseaconnectioninatransactionalcontext,youmustfirstcall pub.db:startTransactiontotakethatconnectionoutofautocommitmode. Thisservicereturnsanexceptionifanerroroccurswhenstartingthenewtransaction. Commonreasonsforanerrorwhenstartinganewtransactionare: Atransactionisalreadyinprogress(seepub.db:commit,pub.db:rollback,or pub.db:clearTransaction). Thetargetdatabasedoesnotsupporttransactions. Afteratransactionhasbeenstarted,itmustbeterminatedwithacalltoeither pub.db:commit(tosaveallchangestothedatabase)orpub.db:rollback(todiscardchanges). StringMessageindicatingthesuccessorfailureoftheoperation. StringOptional.Aliasofthedatabaseforwhichyouwanttostartthe transaction.Thisinformationispassedautomatically. StringOptional.JDBCURLthatidentifiesthedatabaseresource. StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuser. StringOptional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect.
138
6 Db Folder
pub.db:update
WmDB.Updatesallrowsinatablethatmeetthegivencriteria.Rowsareupdatedwith thesuppliednewdata.Asanalternativetothisservice,considerusingtheservices providedwiththewebMethodsJDBCAdapter. Input Parameters Youmayspecifytheconnectionparametersinoneofthefollowingways: $dbAlias OR $dbURL,$dbUser,$dbPass,$dbDriver OR $dbConnection $dbAlias $dbURL $dbUser $dbPass $dbDriver $dbConnection $dbCatalog StringOptional.Databasealias. StringOptional.JDBCURLthatidentifiesthedatabaseresource. StringOptional.Usernametousetologintothedatabase. StringOptional.Passwordfortheuser. StringOptional.NameoftheJDBCdrivertouse. com.wm.app.b2b.server.DBConnectionOptional.Connectionobject returnedbypub.db:connect. StringOptional.Nameofthedatabasessystemcatalog.Include thisparameterifyourDBMSsupportsdistributeddatabasesand youwanttoupdaterowsinatablethatisnotinthedatabaseto whichyouareconnected. Ifyouarenotusingadistributeddatabasesystemorifyouwant toupdaterowsinthedatabasetowhichyouareconnected,you donotneedtospecifythisparameter. IfyouarerunningagainstDB2,youusethisparameterto specifythedatabaselocation. $dbSchemaPattern StringOptional.Nameoftheschematowhichthetablebelongs. Ifyourdatabasesupportspatternmatchingonschemas,you mayspecifytheschemanamewithapatternmatchingstring, where_representsasinglecharacterand%representsanystring ofcharacters.Forexample,thevalueHR%wouldrepresentany schemabeginningwiththecharactersHR. IfyouarerunningagainstDB2,youusethisparameterto specifythetablesAuthID.
139
6 Db Folder
$dbTable $criteria
StringNameoftabletoupdate. Document Criteriathattherowstoupdatemustmeet. Important! Ifnocriteriaareprovided,allrowsareupdated.
$set Output Parameters $updateCount $dbMessage
Document Newdatawithwhichtoupdaterows.
StringNumberofrowsupdated. StringConditional.Messageindicatingtheoperationfailed.
140
Document Folder
Youusetheelementsinthedocumentfoldertoperformoperationsondocumentsinthe pipeline.
141
7 Document Folder

Thefollowingelementsareavailableinthisfolder: Element pub.document:documentListToDocument Package and Description WmPublic.Constructsadocument(anIData object)fromadocumentlist(anIData[])by generatingkey/valuepairsfromthevaluesof twoelementsthatyouspecifyinthedocument list. WmPublic.Expandsthecontentsofadocument intoalistofdocuments. WmPublic.Convertsadocument(IDataobject) toaStringbyencodingitinwebMethods XMLValuesformat. WmPublic.DecodesaStringcontainingan XMLValuesencodeddocumentandproducesa document(IDataobject).
pub.document:documentToDocumentList pub.document:documentToXMLValues
pub.document:XMLValuesToDocument
pub.document:documentListToDocument
WmPublic.Constructsadocument(anIDataobject)fromadocumentlist(anIData[])by generatingkey/valuepairsfromthevaluesoftwoelementsthatyouspecifyinthe documentlist. ThefollowingillustrateshowdocumentListToDocumentwouldconvertadocumentlistthat containsthreedocumentstoasingledocumentcontainingthreekey/valuepairs.When youusedocumentListToDocument,youspecifywhichtwoelementsfromthesourcelistareto betransformedintothekeysandvaluesintheoutputdocument.Inthisexample,the valuesfromthepNameelementsinthesourcelistaretransformedintokeynames,and thevaluesfromthepValueelementsaretransformedintothevaluesforthesekeys.
142
7 Document Folder
A document List containing these three documents... Key pName pValue pName pValue pName pValue Input Parameters documentList Value
cx_timeout 1000
Would be converted to a document containing these three keys... Key cx_timeout cx_max cx_min Value
1000 2500 10
cx_max 2500
cx_min 10
Document List Setofdocuments(IData[])thatyouwanttotransform intoasingledocument(IDataobject). Note: IfdocumentListcontainsasingledocumentinsteadofa DocumentList,documentListToDocumentdoesnothing.
name
StringNameoftheelementindocumentListwhosevalueprovidesthe nameofeachkeyintheresultingdocument. Important! Thedatatypeoftheelementthatyouspecifyinnamemust beString.
value
StringNameoftheelementindocumentListwhosevalueswillbe assignedtothekeysspecifiedinname.Thiselementcanbeofanydata type.
Output Parameters document DocumentDocument(IDataobject)containingthekey/valuepairs generatedfromdocumentList.
143
7 Document Folder
pub.document:documentToDocumentList
WmPublic.Expandsthecontentsofadocumentintoalistofdocuments. Eachkey/valuepairinthesourcedocumentistransformedtoasingledocument containingtwokeys(whosenamesyouspecify).Thesetwokeyswillcontainthekey nameandvalueoftheoriginalpair. Thefollowingshowshowadocumentcontainingthreekeyswouldbeconvertedtoa documentlistcontainingthreedocuments.Inthisexample,thenamespNameandpValue werespecifiedasnamesforthetwonewkeysinthedocumentlist. A document containing these three keys... Key cx_timeout cx_max cx_min Value
1000 2500 10
Would be converted to a document list containing these three documents... Key pName pValue pName pValue pName pValue Value
cx_timeout 1000
cx_max 2500
cx_min 10
Input Parameters document name DocumentDocument(IDataobject)totransform. StringNametoassigntothekeythatwillreceivethekeynamefrom theoriginalkey/valuepair(intheexampleabove,thisparameterwas settopName). StringNametoassigntothekeythatwillreceivethevaluefromthe originalkey/valuepair(intheexampleabove,thisparameterwasset topValue).
value
Output Parameters documentList Document ListListcontainingadocumentforeachkey/valuepairin document.Eachdocumentinthelistwillcontaintwokeys,whose nameswerespecifiedbynameandvalue.Thevaluesofthesetwokeys willbethenameandvalue(respectively)oftheoriginalpair.
144
7 Document Folder
pub.document:documentToXMLValues
WmPublic.Convertsadocument(IDataobject)toaStringbyencodingitinwebMethods XMLValuesformat. ToconverttheencodedStringbackintoanIDataobject,use pub.document:XMLValuesToDocument. Input Parameters document DocumentDocument(IDataobject)toconvert.Thisdocumentcan containanynumberofotherfields,lists,andotherdocuments.
Output Parameters xmlvalues StringStringrepresentationofdocument,encodedinwebMethods XMLValuesformat.
pub.document:XMLValuesToDocument
WmPublic.DecodesaStringcontaininganXMLValuesencodeddocumentandproduces adocument(IDataobject). AnXMLValuesencodeddocumentisproducedusingpub.document:documentToXMLValues. Input Parameters xmlvalues StringAnXMLValuesencodingofadocument. Important! ThisStringmustcontainawebMethodsXMLValues encodingofadocument.Nootherencodingformatisaccepted. Output Parameters document DocumentDocument(IDataobject)resultofthedecodingofxmlvalues.
145
7 Document Folder
146
Event Folder
Youusetheelementsintheeventfoldertowriteyourowneventhandlerservices.
147
8 Event Folder

Thefollowingelementsareavailableinthisfolder: Element pub.event:addSubscriber pub.event:alarm pub.event:alarmInfo pub.event:audit pub.event:auditInfo pub.event:callStackItem Package and Description WmPublic.Createsasubscriptionforaspecified event. WmPublic.Specificationforalarmeventhandlers. WmPublic.Documenttypeforalarmevent information. WmPublic.Specificationforauditeventhandlers. WmPublic.Documenttypeforauditevent information. WmPublic.Documenttypeforthenameofthe serviceintheinvocationpathwhenanexception occurred. WmPublic.Removesaneventhandlerfromthe subscriptionlistforaspecifiedevent. WmPublic.Specificationforexceptionevent handlers. WmPublic.Documenttypeforexception information. WmPublic.SpecificationforgdEndeventhandlers. WmPublic.DocumenttypeforgdEndevent information. WmPublic.SpecificationforgdStartevent handlers. WmPublic.DocumenttypeforgdStartevent information. WmPublic.Returnsthelistofsupportedevent types. WmPublic.Returnsthelistofsubscribersfora specifiedeventtype. WmPublic.SpecificationforaJMSretrievalfailure eventhandler. WmPublic.SpecificationfortheJMSdelivery failureeventhandler. WmPublic.Modifiestheinformationabouta subscription.
pub.event:deleteSubscriber pub.event:exception pub.event:exceptionInfo pub.event:gdEnd pub.event:gdEndInfo pub.event:gdStart pub.event:gdStartInfo pub.event:getEventTypes pub.event:getSubscribers pub.event:jmsReceiveErrorEvent pub.event:jmsSendErrorEvent pub.event:modifySubscriber
148
8 Event Folder
Element pub.event:portStatus pub.event:portStatusInfo pub.event:reloadEventManagerSettings
Package and Description WmPublic.Specificationforaportstatusevent. WmPublic.Documenttypeforportevent information. WmPublic.Reloadsthesettingsfromtheevent managersconfigurationfile(eventcfg.bin)onthe server. WmPublic.Specificationforreplicationevent handlers. WmPublic.Documenttypeforreplicationevent information. WmPublic.Savesthecurrentsubscriber informationtotheeventmanagersconfiguration file(eventcfg.bin)ontheserver. WmPublic.Specificationforsecurityevent handlers. WmPublic.Documenttypeforsecurityevent information. WmPublic.SpecificationforsessionEndevent handlers. WmPublic.DocumenttypeforsessionEndevent information. WmPublic.SpecificationforsessionExpireevent handlers. WmPublic.DocumenttypeforsessionExpireevent information. WmPublic.SpecificationforsessionStartevent handlers. WmPublic.DocumenttypeforsessionStartevent information. WmPublic.Specificationforstateventhandlers. WmPublic.Documenttypeforstatevent information. WmPublic.SpecificationfortxEndeventhandlers. WmPublic.DocumenttypefortxEndevent information.
pub.event:replication pub.event:replicationInfo pub.event:saveEventManagerSettings
pub.event:security pub.event:securityInfo pub.event:sessionEnd pub.event:sessionEndInfo pub.event:sessionExpire pub.event:sessionExpireInfo pub.event:sessionStart pub.event:sessionStartInfo pub.event:stat pub.event:statInfo pub.event:txEnd pub.event:txEndInfo
149
8 Event Folder
Element pub.event:txStart pub.event:txStartInfo
Package and Description WmPublic.SpecificationfortxStarteventhandlers. WmPublic.DocumenttypefortxStartevent information.
pub.event:addSubscriber
WmPublic.Createsasubscriptionforaspecifiedevent. Important! Subscriptionsthatyouaddusingthisservicetakeeffectimmediately; however,theyarenotmadepermanentunlessyoualsopersistthemtodiskwiththe pub.event:saveEventManagerSettingsservice.Ifyoudonotrun pub.event:saveEventManagerSettingsafteraddingsubscribers,yourchangeswillbelost whentheserverisrestarted. Input Parameters EventType StringTypeofeventtowhichtheeventhandlerissubscribing.Must beoneofthefollowing:
Alarm Event Audit Event Exception Event GD End Event GD Start Event JMS Delivery Failure Event JMS Retrieval Failure Event Port Status Event Replication Event Security Event Session End Event Session Expire Event Session Start Event Stat Event Tx End Event Tx Start Event
Tip! Toviewthecurrentlistofeventtypes,youcanexecutethe pub.event:getEventTypesserviceinDeveloper. Filter StringSelects(filters)thesetofeventswithinEventTypetowhichthe eventhandlerissubscribing.addSubscriberusesFilterasapattern stringtofilteraparticularattributeofanevent. Thepatternstringcanbecomposedofliteralcharacters,which matchacharacterexactly,and/orthe*character,whichmatches anysequenceofcharacters.Forexample:
150
8 Event Folder
This pattern string...

* M* M*X
Would match... Anystring AnystringthatstartswithanuppercaseM. AnystringthatstartswithanuppercaseM andendswithanuppercaseX.
Thefollowingtableshowstheattributethatisfilteredforeachevent type.Notethatsomeeventtypescannotbefiltered. EventType

Alarm Event Audit Event
Filtered attribute Messagegeneratedbythealarmevent. Fullyqualifiednameoftheservicethat generatestheauditevent. Fullyqualifiednameoftheservicethat generatestheexceptionevent. None.Thiseventtypecannotbefiltered.Filter isignoredforthiseventtype. Fullyqualifiednameoftheservicethat generatestheGDStartEvent. NameoftheJMSconnectionaliasusedtosend themessagetotheJMSprovider. FullyqualifiednameoftheJMStriggerthat invokedthetriggerserviceforwhichtheerror occurred. None.Thiseventtypecannotbefiltered.Filter isignoredforthiseventtype. Nameofthepackagebeingreplicated. None.Thiseventtypecannotbefiltered.Filter isignoredforthiseventtype. None.Thiseventtypecannotbefiltered.Filter isignoredforthiseventtype. None.Thiseventtypecannotbefiltered.Filter isignoredforthiseventtype.
Exception Event
GD End Event
GD Start Event
JMS Delivery Failure Event JMS Retrieval Failure Event
Port Status Event Replication Event Security Event
Session End Event Session Expire Event
151
8 Event Folder
Session Start Event
UserIDoftheuserstartingthesessionorthe groupstowhichtheuserbelongs.(Thefilteris appliedtoaspacedelimitedlistofgroups, composedofgroupnamessuffixedwiththe usersuserID.) Thefollowingexamplesshowhowyoumight filtersessionstarteventsforvariousgroups and/oruserIDs: Toselectsessionstartsforanyuserinthe Administratorsgroup,thefilterwouldbe:
*Administrators*
ToselectsessionstartsfortheuserID LRMalleyintheAdministratorsgroup,the filterwouldbe:

*Administrators*LRMalley
ToselectsessionstartsfortheuserID LRMalleyinanygroup,thefilterwouldbe:
*LRMalley Stat Event
None.Thiseventtypecannotbefiltered.Filter isignoredforthiseventtype. None.Thiseventtypecannotbefiltered.Filter isignoredforthiseventtype. None.Thiseventtypecannotbefiltered.Filter isignoredforthiseventtype.
Tx End Event
Tx Start Event
Service
StringFullyqualifiednameoftheeventhandlerservice(theservice thatwillexecutewhentheeventspecifiedbyEventTypeandFilter occurs). StringDescriptivecommentforthissubscription.Thiscommentis displayedwhensubscriptionsareviewedwithDeveloper. StringFlagspecifyingthestatusofthesubscription.Mustbeoneof thefollowingvalues: Set to...

true false
Comment Enabled
To... Makethesubscriptionactive. Default.Makethesubscriptioninactive. Note: Althoughthedefaultvalueisfalse,you willgenerallywanttosetEnabledtotrueto activatethesubscriptionimmediatelywhenitis added.
152
8 Event Folder
Output Parameters Result StringFlagindicatingwhetherthesubscriberwassuccessfully added. A value of...

true false
Indicates that... Thesubscriberwasaddedsuccessfully. Thesubscriberwasnotadded.
See Also pub.event:deleteSubscriber pub.event:modifySubscriber pub.event:getSubscribers pub.event:saveEventManagerSettings
pub.event:alarm
WmPublic.Specificationforalarmeventhandlers. Input Parameters time service sessionID msg StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringFullyqualifiednameoftheservicethatgeneratedtheevent. StringSessionIDoftheservicefiringthealarm. StringTextdescribingthealarm.
Output Parameters None. Usage Notes RemembertoregisteryourhandlerwiththeEventManager.
pub.event:alarmInfo
WmPublic.Documenttypeforalarmeventinformation. Parameters time service StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringFullyqualifiednameoftheservicethatgeneratedtheevent.
153
8 Event Folder
sessionID msg
StringSessionIDoftheservicefiringthealarm. StringTextdescribingthealarm.
pub.event:audit
WmPublic.Specificationforauditeventhandlers. Input Parameters time TID service sessionID result StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringTransactionIDoftheservicethatgeneratedtheevent. StringFullyqualifiednameoftheservicethatgeneratedtheevent. StringSessionIDoftheservicethatgeneratedtheevent. StringDescriptionoftheauditpoint. A value of...
begin ok
Indicates that... Thiseventmarksthebeginningofaservice. Thiseventmarkstheendofaservicethatexecuted successfully. Thiseventmarkstheendofaservicethatexecuted unsuccessfully(thatis,threwanexception).Thisstring willstartwiththecharacterserrorandbefollowedby additionaltextcontainingspecificerrorinformation abouttheexception.
errorInfo
pipeline userName
DocumentOptional.Stateofthepipelineattheauditpoint. StringUserIDthatinvokedtheservicethatgeneratedtheevent.
Output Parameters None. Usage Notes RemembertoregisteryourhandlerwiththeEventManager.Notallaudithandlers thatyoucodewillloginformation. Whenwritingyourownaudithandler,becarefultonotmodifythepipelinevariable withinyourhandler. Usethewatt.server.event.audit.asyncserverparametertoindicatewhetherevent handlersforauditeventsareinvokedsynchronouslyorasynchronously.Whenthis parameterissettotrue,IntegrationServerinvokestheeventhandlersthatsubscribe toauditeventsasynchronously.Whenthisparameterissettofalse,IntegrationServer
154
8 Event Folder
invokestheeventhandlersthatsubscribetoauditeventssynchronously.Thedefault istrue(asynchronous).
pub.event:auditInfo
WmPublic.Documenttypeforauditeventinformation. Parameters time TID service sessionID result StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringTransactionIDoftheservicethatgeneratedtheevent. StringFullyqualifiednameoftheservicethatgeneratedtheevent. StringSessionIDoftheservicethatgeneratedtheevent. StringDescriptionoftheauditpoint. A value of...
begin ok
Indicates that... Thiseventmarksthebeginningofaservice. Thiseventmarkstheendofaservicethatexecuted successfully. Thiseventmarkstheendofaservicethatexecuted unsuccessfully(thatis,threwanexception).Thisstring willstartwiththecharacterserrorandbefollowedby additionaltextcontainingspecificerrorinformation abouttheexception.
errorInfo
pipeline userName Usage Notes
DocumentOptional.Stateofthepipelineattheauditpoint. StringUserIDthatinvokedtheservicethatgeneratedtheevent.
Usethewatt.server.event.audit.async serverparametertoindicatewhetherevent handlersforauditeventsareinvokedsynchronouslyorasynchronously.Whenthis parameterissettotrue,IntegrationServerinvokestheeventhandlersthatsubscribe toauditeventsasynchronously.Whenthisparameterissettofalse,IntegrationServer invokestheeventhandlersthatsubscribetoauditeventssynchronously.Thedefault istrue(asynchronous).
155
8 Event Folder
pub.event:callStackItem
WmPublic.Documenttypeforthenameoftheserviceintheinvocationpathwhenan exceptionoccurred. Parameters service StringFullyqualifiednameofthelastservice(thatis,mostrecently called)onthecallstack.
pub.event:deleteSubscriber
WmPublic.Removesaneventhandlerfromthesubscriptionlistforaspecifiedevent. Important! Deletionsmadeusingthisservicetakeeffectimmediately;however,they arenotmadepermanentunlessyoupersistthemtodiskwiththe pub.event:saveEventManagerSettingsservice.Ifyoudonotrun pub.event:saveEventManagerSettingsafterdeletingsubscribers,yourchangeswillbelost whentheserverisrestarted. Input Parameters EventType StringTypeofeventfromwhichtheeventhandlerisunsubscribing. Mustbeoneofthefollowingvalues:
Tip! Toviewthecurrentlistofeventtypes,youcanexecutethe pub.event:getEventTypesserviceinDeveloper. gID StringIDofthesubscriberthatyouwanttodelete.Togetalistof subscriberIDs,executethepub.event:getSubscribersservice.
156
8 Event Folder
Output Parameters Result StringFlagindicatingwhetherthesubscriberwassuccessfully deleted. A value of...

true false
Indicates that... Thesubscriberwasdeletedsuccessfully. Thesubscriberwasnotdeleted(typicallyaninvalid subscriberIDwasprovidedingID).
See Also pub.event:addSubscriber pub.event:modifySubscriber pub.event:getSubscribers pub.event:saveEventManagerSettings
pub.event:exception
WmPublic.Specificationforexceptioneventhandlers. Input Parameters time error localizedError errorType errorDump service user callStack StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringOptional.Errormessageoftheexception. StringOptional.Errormessageinthelanguagethatcorrespondsto thelocaleofyourwebMethodsinstallation. StringExceptiontypethatwasthrown. StringMoredetailedinformationabouttheexception. StringOptional.Fullyqualifiednameoftheservicethatgenerated theevent. StringUserthatrequestedtheservicethatgeneratedtheevent. Document List Optional.Adocumentlistcontaininginformation abouttheservicesonthecallstackwhentheexceptionoccurred.The structureofthedocumentsinthislistisdefinedby pub.event:callStackItem. DocumentOptional.Stateofthepipelineatthetimetheexception occurred. StringThreadIDidentifyingthethreadthatinvokedtheservice. StringSessionIDduringwhichtheexceptionoccurred.
pipeline threadID ssnid
157
8 Event Folder
errorMsgID errorDetails
StringOptional.Theidentificationnumberfortheerrormessage. DocumentOptional.Additionalexceptioninformationprovidedby theauthoroftheJavaservice.Formoreinformationabout constructingexceptionstoreturnadditionalinformation,seethe webMethodsIntegrationServerJavaAPIReferenceforthe com.wm.util.LocalizedExceptionclass. DocumentOptional.Nestederrorsandexceptions,ifany.The structureofthisdocumentisdefinedbypub.event:exceptionInfo.
nestedErrorInfo Output Parameters None. Usage Notes
RemembertoregisteryourhandlerwiththeEventManager. Notallexceptionhandlersthatyoucodewillloginformation. Usethewatt.server.event.exception.asyncserverparametertoindicatewhether eventhandlersforexceptioneventsareinvokedsynchronouslyorasynchronously. Whenthisparameterissettotrue,IntegrationServerinvokestheeventhandlersthat subscribetoexceptioneventsasynchronously.Whenthisparameterissettofalse, IntegrationServerinvokestheservicesthatsubscribetotheexceptionevents synchronously.Thedefaultistrue(asynchronous).
pub.event:exceptionInfo
WmPublic.Documenttypeforexceptioninformation. Parameters time error localizedError errorType errorDump service user StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringOptional.Errormessageoftheexception. StringOptional.Errormessageinthelanguagethatcorrespondsto thelocaleofyourwebMethodsinstallation. StringExceptiontypethatwasthrown. StringMoredetailedinformationabouttheexception. StringOptional.Fullyqualifiednameoftheservicethatgenerated theevent. StringUserthatrequestedtheservicethatgeneratedtheevent.
158
8 Event Folder
callStack
Document List Optional.Thecallstackwhentheexceptionoccurred. Eachdocumentrepresentsaserviceonthecallstack.Thestructureof thisdocumentisdefinedbypub.event:callStackItem. DocumentOptional.Stateofthepipelineatthetimetheexception occurred. StringThreadIDidentifyingthethreadthatinvokedtheservice. StringSessionIDduringwhichtheexceptionoccurred. StringOptional.Theidentificationnumberfortheerrormessage. DocumentOptional.Additionalexceptioninformationprovidedby theauthoroftheJavaservice.Formoreinformationabout constructingexceptionstoreturnadditionalinformation,seethe webMethodsIntegrationServerJavaAPIReferenceforthe com.wm.util.LocalizedExceptionclass. DocumentOptional.Nestederrorsandexceptions,ifany.The structureofthisdocumentisdefinedbypub.event:exceptionInfo.
pipeline threadID ssnid errorMsgID errorDetails
nestedErrorInfo Usage Notes
Usethewatt.server.event.exception.async serverparametertoindicatewhether eventhandlersforexceptioneventsareinvokedsynchronouslyorasynchronously. Whenthisparameterissettotrue,IntegrationServerinvokestheeventhandlersthat subscribetoexceptioneventsasynchronously.Whenthisparameterissettofalse, IntegrationServerinvokestheservicesthatsubscribetotheexceptionevents synchronously.Thedefaultistrue(asynchronous).
pub.event:gdEnd
WmPublic.SpecificationforgdEndeventhandlers. Input Parameters time TID result StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringTransactionIDoftheservicethatgeneratedtheevent. StringStatusofthetransaction.
Output Parameters None.
159
8 Event Folder
Usage Notes RemembertoregisteryourhandlerwiththeEventManager. Usethewatt.server.event.gd.asyncserverparametertoindicatewhetherevent handlersforallguaranteeddeliveryevents(gdStartandgdEnd)areinvoked synchronouslyorasynchronously.Whenthisparameterissettotrue,Integration ServerinvokestheeventhandlersthatsubscribetothegdStartand/orgdEndevents asynchronously.Whenthisparameterissettofalse,IntegrationServerinvokesthe eventhandlersthatsubscribetothegdStartand/orgdEndeventssynchronously.The defaultistrue(asynchronous).
pub.event:gdEndInfo
WmPublic.DocumenttypeforgdEndeventinformation. Parameters time TID result Usage Notes Usethewatt.server.event.gd.asyncserverparametertoindicatewhetherevent handlersforallguaranteeddeliveryevents(gdStartandgdEnd)areinvoked synchronouslyorasynchronously.Whenthisparameterissettotrue,Integration ServerinvokestheeventhandlersthatsubscribetothegdStartand/orgdEndevents asynchronously.Whenthisparameterissettofalse,IntegrationServerinvokesthe eventhandlersthatsubscribetothegdStartand/orgdEndeventssynchronously.The defaultistrue(asynchronous). StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringTransactionIDoftheservicethatgeneratedtheevent. StringStatusofthetransaction.
pub.event:gdStart
WmPublic.SpecificationforgdStarteventhandlers. Input Parameters time TID svcname result StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringTransactionIDoftheservicethatgeneratedtheevent. StringFullyqualifiednameoftheservicethatgeneratedtheevent. StringStatusofthetransaction.
160
8 Event Folder
Output Parameters None. Usage Notes RemembertoregisteryourhandlerwiththeEventManager. Usethewatt.server.event.gd.asyncserverparametertoindicatewhetherevent handlersforallguaranteeddeliveryevents(gdStartandgdEnd)areinvoked synchronouslyorasynchronously.Whenthisparameterissettotrue,Integration ServerinvokestheeventhandlersthatsubscribetothegdStartand/orgdEndevents asynchronously.Whenthisparameterissettofalse,IntegrationServerinvokesthe eventhandlersthatsubscribetothegdStartand/orgdEndeventssynchronously.The defaultistrue(asynchronous).
pub.event:gdStartInfo
WmPublic.DocumenttypeforgdStarteventinformation. Parameters time TID svcname result Usage Notes Usethewatt.server.event.gd.asyncserverparametertoindicatewhetherevent handlersforallguaranteeddeliveryevents(gdStartandgdEnd)areinvoked synchronouslyorasynchronously.Whenthisparameterissettotrue,Integration ServerinvokestheeventhandlersthatsubscribetothegdStartand/orgdEndevents asynchronously.Whenthisparameterissettofalse,IntegrationServerinvokesthe eventhandlersthatsubscribetothegdStartand/orgdEndeventssynchronously.The defaultistrue(asynchronous). StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringTransactionIDoftheservicethatgeneratedtheevent. StringFullyqualifiednameoftheservicethatgeneratedtheevent. StringStatusofthetransaction.
161
8 Event Folder
pub.event:getEventTypes
WmPublic.Returnsthelistofsupportedeventtypes. Input Parameters None. Output Parameters EventTypes DocumentThetypesofeventsthattheserversupports:
162
8 Event Folder
pub.event:getSubscribers
WmPublic.Returnsthelistofsubscribersforaspecifiedeventtype. Input Parameters EventType StringTypeofeventforwhichyouwantthelistofsubscribers.Mustbe oneofthefollowingvalues:
Tip! Toviewthecurrentlistofeventtypes,youcanexecutethe pub.event:getEventTypesserviceinDeveloper. Output Parameters Subscribers DocumentThelistofsubscribers.Foreachsubscriber,Subscriberswill containakeythatisthesubscriberID.Thevalueofthatkeyisa documentcontainingthefollowinginformationaboutthe subscriber: Key Service Description StringFullyqualifiednameoftheeventhandlerservice (thatis,theservicethatsubscribestotheeventin EventType).
163
8 Event Folder
Filter
StringFilterassociatedwiththesubscription.Thisisa patternstringthatselects(filters)aneventbasedona particularattribute.Filteriscomposedofliteral characters,whichmatchacharacterexactly,and/orthe *character,whichmatchesanysequenceof characters.Forexample: This string...

* M*
Would match... Anystring Anystringthatstartswithanuppercase M. Anystringthatstartswithanuppercase MandendswithanuppercaseX.
M*X
Foralistofattributestowhichthefilterisapplied,see pub.event:addSubscriber. Comment StringDescriptivecommentassociatedwiththe description.Ifacommenthasnotbeenassignedtothe subscription,Commentwillbeempty. StringSubscriberID. StringFlagindicatingthestatusofthesubscription. Willbeoneofthefollowingvalues: Key
true false
gID Enabled
Description Subscriptionisactive. Subscriptionisinactive.
See Also pub.event:addSubscriber pub.event:modifySubscriber pub.event:deleteSubscriber
164
8 Event Folder
pub.event:jmsReceiveErrorEvent
WmPublic.SpecificationforaJMSretrievalfailureeventhandler. Input Parameters triggerName StringSpecifiesthenameoftheJMStriggerthatexecutedthe triggerserviceforwhichtheJMSretrievalfailureevent occurred. java.lang.IntegerSpecifiestheindexforthedestinationfrom whichtheJMStriggerreceivesmessages.AJMStriggerthat specifiesajointypecanlistenformessagesfrommultiple destinations.Thefirstdestinationlistedhasanindexof0,the seconddestinationlistedhasanindicesof1,etc. java.lang.IntegerNumberoftimestheJMSproviderdelivered themessagetotheJMStriggeratthetimetheeventoccurred. String Dateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS String Nameoftheclassthatcausedthefailure.Thismaybe usefultodetermineprogrammaticallywhytheerror occurred. String Messagecontainedintheexception. DocumentAdocument(IData)containingtheJMSmessage beingprocessedwhentheerroroccurred. Key JMSMessage Output Parameters None Usage Notes AJMSretrievalfailureeventoccursinthefollowingsituations: AtriggerserviceexecutedbyaJMStriggerthrowsanontransienterrorandthe watt.server.jms.trigger.raiseEventOnExceptionpropertyissettotrue(the default). AtriggerserviceassociatedwithaJMStriggerendsbecauseofatransienterror, allretryattemptshavebeenmade,andtheJMStriggerisconfiguredtothrowan exceptiononretryfailure.Inaddition,the watt.server.jms.trigger.raiseEventOnRetryFailurepropertyissettotrue(the default). Description Adocumentreference(IData)tothe pub.jms:JMSMessagedocumenttype.
triggerDestinationIndex
deliveryCount time exceptionClass
exceptionMessage data
165
8 Event Folder
ThemaximumdeliverycountfromtheJMSproviderhasbeenmetforthe messageandthewatt.server.jms.trigger.raiseEventOnRetryFailureproperty issettotrue(thedefault). The watt.server.jms.trigger.maxDeliveryCountpropertyspecifiesthemaximum numberoftimestheJMSprovidercandeliveramessagetoIntegrationServer. Thedefaultis100.InaJMSmessage,thepropertyJMSXDeliveryCountspecifies thenumberoftimestheJMSproviderdeliveredthemessage.MostJMSproviders setthisvalue. Whileperformingexactlyonceprocessing,theconnectiontothedocument historydatabaseisunavailable,andtransienterrorhandlingfortheJMStriggeris configuredto Throw exception(nontransactedJMStrigger)orRecover only (transactedJMStrigger).Inaddition,the watt.server.jms.trigger.raiseEventOnRetryFailurepropertyissettotrue(the default). Whileperformingexactlyonceprocessing,thedocumentresolverserviceends withanISRuntimeException,andtransienterrorhandlingfortheJMStriggeris configuredto Throw exception(nontransactedJMStrigger)orRecover only (transactedJMStrigger).Inaddition,the watt.server.jms.trigger.raiseEventOnRetryFailurepropertyissettotrue(the default). Whileperformingexactlyonceprocessing,thedocumentresolverserviceends withanexceptionotherthananISRuntimeException.Inaddition,the watt.server.jms.trigger.raiseEventOnRetryFailurepropertyissettotrue(the default). RemembertoregisteryoureventhandlerwiththeEventManager. Usethewatt.server.event.jmsRetrievalError.asyncserverparametertoindicate whethereventhandlersforJMSretrievalfailureeventsareinvokedsynchronouslyor asynchronously.Whenthisparameterissettotrue,IntegrationServerinvokesthe eventhandlersthatsubscribetoJMSretrievalfailureeventsasynchronously.When thisparameterissettofalse,IntegrationServerinvokestheeventhandlersthat subscribetotheJMSretrievalfailureeventssynchronously.Thedefaultistrue (asynchronous). See Also pub.jms:JMSMessage
166
8 Event Folder
pub.event:jmsSendErrorEvent
WmPublic.SpecificationfortheJMSdeliveryfailureeventhandler. Input Parameters aliasName time data Output Parameters None Usage Notes IntegrationServergeneratesaJMSdeliveryfailureeventwhenamessagewrittento theclientsidequeuecannotbedeliveredtotheJMSprovider.Whenatransienterror occurs,severaldeliveryattemptsmayhavebeenmade. YoumightwanttocreateaneventhandlerforaJMSdeliveryfailureeventtosend notificationorloginformationabouttheundeliveredJMSmessage.Youcanalso createaneventhandlerthatattemptstoresendthemessagetotheJMSprovider. RemembertoregisteryoureventhandlerwiththeEventManager. Usethewatt.server.event.jmsDeliveryFailureError.asyncserverparameterto indicatewhethereventhandlersforJMSdeliveryfailureeventsareinvoked synchronouslyorasynchronously.Whenthisparameterissettotrue,Integration ServerinvokestheeventhandlersthatsubscribetoJMSdeliveryfailureevents asynchronously.Whenthisparameterissettofalse,IntegrationServerinvokesthe eventhandlersthatsubscribetotheJMSdeliveryfailureeventssynchronously.The defaultistrue(asynchronous). StringNameoftheJMSconnectionaliasusedtosendthemessage totheJMSprovider. String Dateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS DocumentContentsoftheJMSmessagethatcouldnotbesenttothe JMSprovider.
pub.event:modifySubscriber
WmPublic.Modifiestheinformationaboutasubscription. Important! Thechangesyoumakewiththisservicetakeeffectimmediately;however, theyarenotmadepermanentunlessyoualsopersistthemtodiskwiththe pub.event:saveEventManagerSettingsservice.Ifyoudonotrun pub.event:saveEventManagerSettingsaftermodifyingsubscribers,yourchangeswillbelost whentheserverisrestarted.
167
8 Event Folder
Input Parameters EventType StringEventtypethatyouwantthesubscriptiontohave:

Tip! Toviewthecurrentlistofeventtypes,youcanexecutethe pub.event:getEventTypesserviceinDeveloper. gID Filter StringIDofthesubscriberthatyouwanttomodify.Togetthecurrent listofsubscriberIDs,executethepub.event:getSubscribersservice. StringFilterthatyouwantsubscriptiontohave.Filterisapattern matchingstringcomposedofliteralcharacters,whichmatcha characterexactly,and/orthe*character,whichmatchesany sequenceofcharacters.Forexample: This pattern string...
* M*
Would match... Anystring Anystringthatstartswithanuppercase M. AnystringthatstartswithanuppercaseM andendswithanuppercaseX.
M*X
Thefollowingtableshowstheattributethatisfilteredforeachevent type.Notethatsomeeventtypescannotbefiltered. EventType

Alarm Event Audit Event
Filtered attribute Messagegeneratedbythealarmevent. Fullyqualifiednameoftheservicethat generatestheauditevent. Fullyqualifiednameoftheservicethat generatestheexceptionevent.
Exception Event
168
8 Event Folder
GD End Event
None.Thiseventtypecannotbefiltered. Filterisignoredforthiseventtype. Fullyqualifiednameoftheservicethat generatestheGDStartEvent. NameoftheJMSconnectionaliasusedto sendthemessagetotheJMSprovider. FullyqualifiednameoftheJMStriggerthat calledthetriggerserviceforwhichtheerror occurred. None.Thiseventtypecannotbefiltered. Filterisignoredforthiseventtype. Nameofthepackagebeingreplicated. None.Thiseventtypecannotbefiltered. Filterisignoredforthiseventtype. None.Thiseventtypecannotbefiltered. Filterisignoredforthiseventtype. None.Thiseventtypecannotbefiltered. Filterisignoredforthiseventtype. UserIDoftheuserstartingthesessionorthe groupstowhichtheuserbelongs.(Thefilter isappliedtoaspacedelimitedlistofgroups, composedofgroupnamessuffixedwiththe usersuserID.) Thefollowingexamplesshowhowyou mightfiltersessionstarteventsforvarious groupsand/oruserIDs: Toselectsessionstartsforanyuserinthe Administratorsgroup,thefilterwouldbe:
*Administrators*
GD Start Event
JMS Delivery Failure Event JMS Retrieval Failure Event
Port Status Event
Replication Event Security Event
Session End Event
Session Expire Event
Session Start Event
ToselectsessionstartsfortheuserID LRMalleyintheAdministratorsgroup,the filterwouldbe:

*Administrators*LRMalley
ToselectsessionstartsfortheuserID LRMalleyinanygroup,thefilterwould be:

*LRMalley Stat Event
None.Thiseventtypecannotbefiltered. Filterisignoredforthiseventtype.
169
8 Event Folder
Tx End Event
None.Thiseventtypecannotbefiltered. Filterisignoredforthiseventtype. None.Thiseventtypecannotbefiltered. Filterisignoredforthiseventtype.
Tx Start Event
Service Comment Enabled
StringFullyqualifiednameoftheeventhandlerservicethatyouwant thesubscriptiontospecify. StringDescriptivecommentthatyouwanttoassigntothe subscription. StringFlagspecifyingthestatusofthesubscription.Mustbeoneofthe followingvalues: Set to...

true false
To... Makethesubscriptionactive. Default.Makethesubscriptioninactive.
Note: Althoughthedefaultvalueisfalse,youwillgenerallywanttoset Enabledtotruetoactivatethesubscriptionimmediatelyafteritis modified. Output Parameters Result StringFlagindicatingwhetherthesubscriberwassuccessfully modified. A value of...
true false
Indicates that... Thesubscriberwasupdatedsuccessfully. Thesubscriberwasnotupdated(typicallybecausean invalidsubscriberIDwasprovidedingID).
See Also pub.event:addSubscriber pub.event:deleteSubscriber pub.event:getSubscribers pub.event:saveEventManagerSettings
170
8 Event Folder
pub.event:portStatus
WmPublic.Specificationforaportstatusevent. Input Parameters portStatusInfo Document Listofdocuments(Data[]objects)containingthefollowing informationforeachport. Key time port status protocol primary Description StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringNumberfortheport. StringStatusoftheport. StringTypeofport(forexample,http,https,ftp,or
email).
StringPrimaryport.Bydefault,thewebMethods IntegrationServerdesignatesanHTTPportatport5555as theprimaryport. StringFlagindicatingwhetherornottheportisenabled. Set to...

true false
enabled
To indicate that... Theportisenabled. Theportisdisabled.
pub.event:portStatusInfo
WmPublic.Documenttypeforporteventinformation. Parameters time port status protocol StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringNumberfortheport. StringStatusoftheport. StringTypeofport(forexample,http,https,ftp,oremail).
171
8 Event Folder
primary enabled
StringTheprimaryport.Bydefault,thewebMethodsIntegration ServerdesignatesanHTTPportatport5555astheprimaryport. StringAflagindicatingwhetherornottheportisenabled. A value of...

true false
Indicates that... Theportisenabled. Theportisdisabled.
pub.event:reloadEventManagerSettings
WmPublic.Reloadsthesettingsfromtheeventmanagersconfigurationfile (eventcfg.bin)ontheserver. Input Parameters None. Output Parameters None. See Also pub.event:saveEventManagerSettings
pub.event:replication
WmPublic.Specificationforreplicationeventhandlers. Input Parameters time action package service StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringDescriptionoftheevent(suchascreateorpush).Thevalueof actioncanbeusedtomaintainseparatelogsforeachactiontype. StringNameofpackagebeingreplicated. StringFullyqualifiednameoftheservicethatgeneratedtheevent.
172
8 Event Folder
Usage Notes RemembertoregisteryourhandlerwiththeEventManager.Whenyousubscribean eventhandlertoareplicationevent,youcancreateafiltertospecifythepackagethat, whenreplicated,willinvoketheeventhandler. Usethewatt.server.event.replication.asyncserverparametertoindicatewhether eventhandlersforreplicationeventsareinvokedsynchronouslyorasynchronously. Whenthisparameterissettotrue,IntegrationServerinvokestheeventhandlersthat subscribetoreplicationeventsasynchronously.Whenthisparameterissettofalse, IntegrationServerinvokeseventhandlersthatsubscribetoreplicationevents synchronously.Thedefaultistrue(asynchronous).
pub.event:replicationInfo
WmPublic.Documenttypeforreplicationeventinformation. Parameters time action package service Usage Notes Usethewatt.server.event.replication.asyncserverparametertoindicatewhether eventhandlersforreplicationeventsareinvokedsynchronouslyorasynchronously. Whenthisparameterissettotrue,IntegrationServerinvokestheeventhandlersthat subscribetoreplicationeventsasynchronously.Whenthisparameterissettofalse, IntegrationServerinvokeseventhandlersthatsubscribetoreplicationevents synchronously.Thedefaultistrue(asynchronous). StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringDescriptionoftheevent(suchascreateorpush).Thevalueof actioncanbeusedtomaintainseparatelogsforeachactiontype. StringNameofpackagebeingreplicated. StringFullyqualifiednameoftheservicethatgeneratedtheevent.
pub.event:saveEventManagerSettings
WmPublic.Savesthecurrentsubscriberinformationtotheeventmanagersconfiguration file(eventcfg.bin)ontheserver. Important! Alwaysrunthisserviceaftermakinganypermanentchangestosubscriber information(forexample,addsubscribers,modifysubscribers,ordeletesubscribers). Otherwise,yourchangeswillbelostthenexttimetheserverisrestarted.
173
8 Event Folder
Input Parameters None. Output Parameters None. See Also pub.event:addSubscriber pub.event:deleteSubscriber pub.event:modifySubscriber pub.event:reloadEventManagerSettings
pub.event:security
WmPublic.Specificationforsecurityeventhandlers. Input Parameters time clientID serverID userName securityEventType StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringIPaddressofthehostfromwhichtherequestoriginated. StringIPaddressofthehostonwhichIntegrationServeris running. StringUserIDthatinitiatedorperformedthesecurityevent. StringTypeofsecurityevent.Someexamplesare: Authentication, Authorization Certificates Configuration JDBCPools Packages Passwords Ports RemoteServers Services SSL WebServices
174
8 Event Folder
result
StringFlagindicatingwhetherthesecurityactioncompleted successfully. Set to

True False
Indicates that... Thesecurityeventcompletedsuccessfully. Thesecurityeventendedbecauseoffailure.
message
StringIndicateswhatthesecurityactionwas,irrespectiveof whetheritwassuccessfulorunsuccessful.Forexample,ifauser wassuccessfullyaddedtoIntegrationServer,themessagewould sayso.Iftheeventwasunsuccessful,thisstringwouldprovidea meaningfulreasonorinformationaboutthefailure,wherever possible.
Output Parameters None. Usage Notes Usethewatt.server.event.security.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersforsecurityeventssynchronouslyor asynchronously.Whenthisparameterissettotrue,IntegrationServerinvokesthe eventhandlersthatsubscribetosecurityeventsasynchronously.Whenthisparameter issettofalse,IntegrationServerinvokeseventhandlersthatsubscribetosecurity eventssynchronously.Thedefaultistrue(asynchronous).
pub.event:securityInfo
WmPublic.Documenttypeforsecurityeventinformation. Input Parameters Time clientID ServerID userName StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringIPaddressofthehostfromwhichtherequestoriginated. StringIPaddressofthehostonwhichIntegrationServeris running. StringUserIDthatinitiatedorperformedthesecurityevent.
175
8 Event Folder
securityEventType
StringTypeofsecurityevent.Someexamplesare: Authentication Authorization Certificates Configuration JDBCPools Packages Passwords Ports RemoteServers Services SSLWebServices StringFlagindicatingwhetherthesecurityactioncompleted successfully. This value...
True False
result
Indicates that... Thesecurityeventcompletedsuccessfully. Thesecurityeventendedbecauseoffailure.
message
StringIndicateswhatthesecurityactionwas,irrespectiveof whetheritwassuccessfulorunsuccessful.Forexample,ifauser wassuccessfullyaddedtoIntegrationServer,themessagewould sayso.Iftheeventwasunsuccessful,thisstringwouldprovidea meaningfulreasonorinformationaboutthefailure,wherever possible.
Output Parameters None. Usage Notes Usethewatt.server.event.security.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersforsecurityeventssynchronouslyor asynchronously.Whenthisparameterissettotrue,IntegrationServerinvokesthe eventhandlersthatsubscribetosecurityeventsasynchronously.Whenthisparameter issettofalse,IntegrationServerinvokeseventhandlersthatsubscribetosecurity eventssynchronously.Thedefaultistrue(asynchronous).
176
8 Event Folder
pub.event:sessionEnd
WmPublic.SpecificationforsessionEndeventhandlers. Input Parameters time sessionID rpcs age StringDateandtimethattheeventoccurred,intheformat yyyy/MM/dd HH:mm:ss.SS. StringSessionIDoftheservicefiringthealarm. StringNumberofservicecallsthesessionhasperformed. StringNumberofmillisecondsthesessionexistedbeforeitended.
Output Parameters None. Usage Notes RemembertoregisteryourhandlerwiththeEventManager. Usethewatt.server.event.session.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersforsessionevents(sessionStart, sessionEnd,andsessionExpire)synchronouslyorasynchronously.Whenthis parameterissettotrue,IntegrationServerinvokeseventhandlersthatsubscribeto thesessioneventsasynchronously.Whenthisparameterissettofalse,Integration Serverinvokeseventhandlersthatsubscribetothesessioneventssynchronously.The defaultistrue(asynchronous).
pub.event:sessionEndInfo
WmPublic.DocumenttypeforsessionEndeventinformation. Parameters time sessionID rpcs age Usage Notes Usethewatt.server.event.session.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersforsessionevents(sessionStart, sessionEnd,andsessionExpire)synchronouslyorasynchronously.Whenthis parameterissettotrue,IntegrationServerinvokeseventhandlersthatsubscribeto StringDateandtimethattheeventoccurred.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringSessionIDoftheservicefiringthealarm. StringNumberofservicecallsthesessionhasperformed. StringNumberofmillisecondsthesessionexistedbeforeitended.
177
8 Event Folder
thesessioneventsasynchronously.Whenthisparameterissettofalse,Integration Serverinvokeseventhandlersthatsubscribetothesessioneventssynchronously.The defaultistrue(asynchronous).
pub.event:sessionExpire
WmPublic.SpecificationforsessionExpireeventhandlers. Input Parameters time sessionID rpcs age StringDateandtimethattheeventoccurred.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringSessionIDoftheservicefiringthealarm. StringNumberofservicecallsthesessionhasperformed. StringNumberofmillisecondsthesessionexistedbeforeitexpired.
Output Parameters None. Usage Notes RemembertoregisteryourhandlerwiththeEventManager. Usethewatt.server.event.session.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersforsessionevents(sessionStart, sessionEnd,andsessionExpire)synchronouslyorasynchronously.Whenthis parameterissettotrue,IntegrationServerinvokeseventhandlersthatsubscribeto thesessioneventsasynchronously.Whenthisparameterissettofalse,Integration Serverinvokeseventhandlersthatsubscribetothesessioneventssynchronously.The defaultistrue(asynchronous).
pub.event:sessionExpireInfo
WmPublic.DocumenttypeforsessionExpireeventinformation. Parameters time sessionID rpcs age StringDateandtimethattheeventoccurred.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringSessionIDoftheservicefiringthealarm. StringNumberofservicecallsthesessionhasperformed. StringNumberofmillisecondsthesessionexistedbeforeitexpired.
178
8 Event Folder
Usage Notes Usethewatt.server.event.session.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersforsessionevents(sessionStart, sessionEnd,andsessionExpire)synchronouslyorasynchronously.Whenthis parameterissettotrue,IntegrationServerinvokeseventhandlersthatsubscribeto thesessioneventsasynchronously.Whenthisparameterissettofalse,Integration Serverinvokeseventhandlersthatsubscribetothesessioneventssynchronously.The defaultistrue(asynchronous).
pub.event:sessionStart
WmPublic.SpecificationforsessionStarteventhandlers. Input Parameters time sessionID userid sessionName Output Parameters None. Usage Notes RemembertoregisteryourhandlerwiththeEventManager.Whenyousubscribean eventhandlertoaSessionStartevent,youcancreateafiltersothatonlysessionstart eventsgeneratedbyaspecificuserorbyamemberofaspecificgroupinvokethe eventhandler. Usethewatt.server.event.session.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersforsessionevents(sessionStart, sessionEnd,andsessionExpire)synchronouslyorasynchronously.Whenthis parameterissettotrue,IntegrationServerinvokeseventhandlersthatsubscribeto thesessioneventsasynchronously.Whenthisparameterissettofalse,Integration Serverinvokeseventhandlersthatsubscribetothesessioneventssynchronously.The defaultistrue(asynchronous). StringDateandtimethattheeventoccurred.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringIDofthenewsession. StringUserIDthattheISclientordeveloperusedtologontothe webMethodsIntegrationServer. StringNameofthenewsession.
179
8 Event Folder
pub.event:sessionStartInfo
WmPublic.DocumenttypeforsessionStarteventinformation. Parameters time sessionID userid sessionName Usage Notes Usethewatt.server.event.session.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersforsessionevents(sessionStart, sessionEnd,andsessionExpire)synchronouslyorasynchronously.Whenthis parameterissettotrue,IntegrationServerinvokeseventhandlersthatsubscribeto thesessioneventsasynchronously.Whenthisparameterissettofalse,Integration Serverinvokeseventhandlersthatsubscribetothesessioneventssynchronously.The defaultistrue(asynchronous). StringDateandtimethattheeventoccurred.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringIDofthenewsession. StringUserIDthattheISclientordeveloperusedtologontothe webMethodsIntegrationServer. StringNameofthenewsession.
pub.event:stat
WmPublic.Specificationforstateventhandlers. Input Parameters startTime uptime totalMem StringDateandtimethattheeventoccurred.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringAmountoftimetheserverhasbeenup.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringTotalamountofusedandunusedstorageavailabletotheJVM, inkilobytes.Forexample,avalueof65535represents64megabytes ofstorage. StringAmountofunusedstorageavailabletotheIntegrationServer, inkilobytes.Forexample,avalueof65535represents64megabytes ofstorage. StringAmountofstorageusedbytheIntegrationServer,inkilobytes. Forexample,avalueof65535represents64megabytesofstorage. StringPercentoftotalmemoryunused. StringPercentoftotalmemoryused.
freeMem
usedMem freeMemPer usedMemPer
180
8 Event Folder
svrT svrTMax sysT sysTMax conn connMax reqTotal reqAvg newReqPM endReqPM errSvc svcRate ssnUsed ssnPeak ssnMax errSys Output Parameters None. Usage Notes
StringNumberofservicescurrentlyrunning. StringPeaknumberofserverseverrunningconcurrently. StringNumberofJVMthreadsrunning. StringPeaknumberofthreadseverrunning. StringNumberofcurrentsessions. StringPeaknumberofconcurrentsessions. StringCumulativetotalnumberofservicesprocessed. StringAveragedurationofservice. StringNewrequestsperminute. StringEndrequestsperminute. StringNumberofservicescompletedinerrorstate. StringNumberofend/start(s)persecond. StringNumberoflicensedsessionscurrentlyactive. StringNumberoflicensedsessionsthathaveeverrunconcurrently ontheserver. StringMaximumnumberofsessionsforwhichtheserverislicensed. StringNumberofunknownerrors.
RemembertoregisteryourhandlerwiththeEventManager. Usethewatt.server.event.stat.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersforstatisticseventssynchronouslyor asynchronously.Whenthisparameterissettotrue,IntegrationServerinvokesevent handlersthatsubscribetothestateventasynchronously.Whenthisparameterisset tofalse,IntegrationServerinvokeseventhandlersthatsubscribetostatevents synchronously.Thedefaultistrue(asynchronous).
181
8 Event Folder
pub.event:statInfo
WmPublic.Documenttypeforstateventinformation. Parameters startTime uptime totalMem StringDateandtimethattheeventoccurred.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringAmountoftimetheserverhasbeenup.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringTotalamountofusedandunusedstorageavailabletotheJVM, inkilobytes.Forexample,avalueof65535represents64megabytes ofstorage. StringAmountofunusedstorageavailabletotheIntegrationServer, inkilobytes.Forexample,avalueof65535represents64megabytes ofstorage. StringAmountofstorageusedbytheIntegrationServer,inkilobytes. Forexample,avalueof65535represents64megabytesofstorage. StringPercentoftotalmemoryunused. StringPercentoftotalmemoryused. StringNumberofservicescurrentlyrunning. StringPeaknumberofserverseverrunningconcurrently. StringNumberofJVMthreadsrunning. StringPeaknumberofthreadseverrunning. StringNumberofcurrentsessions. StringPeaknumberofconcurrentsessions. StringCumulativetotalnumberofservicesprocessed. StringAveragedurationofservice. StringNewrequestsperminute. StringEndrequestsperminute. StringNumberofservicescompletedinerrorstate. StringNumberofend/start(s)persecond. StringNumberoflicensedsessionscurrentlyactive. StringNumberoflicensedsessionsthathaveeverrunconcurrently ontheserver. StringMaximumnumberofsessionsforwhichtheserverislicensed. StringNumberofunknownerrors.
freeMem
usedMem freeMemPer usedMemPer svrT svrTMax sysT sysTMax conn connMax reqTotal reqAvg newReqPM endReqPM errSvc svcRate ssnUsed ssnPeak ssnMax errSys
182
8 Event Folder
Usage Notes Usethewatt.server.event.stat.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersforstatisticseventssynchronouslyor asynchronously.Whenthisparameterissettotrue,IntegrationServerinvokesevent handlersthatsubscribetothestateventasynchronously.Whenthisparameterisset tofalse,IntegrationServerinvokeseventhandlersthatsubscribetostatevents synchronously.Thedefaultistrue(asynchronous).
pub.event:txEnd
WmPublic.SpecificationfortxEndeventhandlers. Input Parameters time TID result Output Parameters None. Usage Notes RemembertoregisteryourhandlerwiththeEventManager. Usethewatt.server.event.tx.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersfortransactionevents(txStartandtxEnd) synchronouslyorasynchronously.Whenthisparameterissettotrue,Integration ServerinvokeseventhandlersthatsubscribetothetxStartortxEndevents asynchronously.Whenthisparameterissettofalse,IntegrationServerinvokesevent handlersthatsubscribetothetxStartortxEndeventssynchronously.Thedefaultis true(asynchronous). StringDateandtimethattheeventoccurred.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringTransactionIDoftheservicethatgeneratedtheevent. StringStatusofthetransaction.
pub.event:txEndInfo
WmPublic.DocumenttypefortxEndeventinformation. Parameters time TID result StringDateandtimethattheeventoccurred.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringTransactionIDoftheservicethatgeneratedtheevent. StringStatusofthetransaction.
183
8 Event Folder
Usage Notes Usethewatt.server.event.tx.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersfortransactionevents(txStartandtxEnd) synchronouslyorasynchronously.Whenthisparameterissettotrue,Integration ServerinvokeseventhandlersthatsubscribetothetxStartortxEndevents asynchronously.Whenthisparameterissettofalse,IntegrationServerinvokesevent handlersthatsubscribetothetxStartortxEndeventssynchronously.Thedefaultis true(asynchronous).
pub.event:txStart
WmPublic.SpecificationfortxStarteventhandlers. Input Parameters time TID result Output Parameters None. Usage Notes RemembertoregisteryourhandlerwiththeEventManager. Usethewatt.server.event.tx.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersfortransactionevents(txStartandtxEnd) synchronouslyorasynchronously.Whenthisparameterissettotrue,Integration ServerinvokeseventhandlersthatsubscribetothetxStartortxEndevents asynchronously.Whenthisparameterissettofalse,IntegrationServerinvokesevent handlersthatsubscribetothetxStartortxEndeventssynchronously.Thedefaultis true(asynchronous). StringDateandtimethattheeventoccurred.Givenintheformat yyyy/MM/dd HH:mm:ss.SS. StringTransactionIDoftheservicethatgeneratedtheevent. StringStatusofthetransaction.
pub.event:txStartInfo
WmPublic.DocumenttypefortxStarteventinformation. Parameters time StringDateandtimethattheeventoccurred.Givenintheformat yyyy/MM/dd HH:mm:ss.SS.
184
8 Event Folder
TID result Usage Notes
StringTransactionIDoftheservicethatgeneratedtheevent. StringStatusofthetransaction.
Usethewatt.server.event.tx.asyncserverparametertoindicatewhether IntegrationServerinvokeseventhandlersfortransactionevents(txStartandtxEnd) synchronouslyorasynchronously.Whenthisparameterissettotrue,Integration ServerinvokeseventhandlersthatsubscribetothetxStartortxEndevents asynchronously.Whenthisparameterissettofalse,IntegrationServerinvokesevent handlersthatsubscribetothetxStartortxEndeventssynchronously.Thedefaultis true(asynchronous).
185
8 Event Folder
186
File Folder
Youusetheelementsinthefilefoldertoperformoperationsonthelocalfilesystem.
187
9 File Folder

Thefollowingelementsareavailableinthisfolder: Element pub.file:getFile Package and Description WmPublic.Retrievesaspecifiedfilefromthelocalfile system.
pub.file:getFile
WmPublic.Retrievesaspecifiedfilefromthelocalfilesystem. IfthefilecontainsanXMLdocument,youcanusetheservicesintheXML Foldertoconvert ittoanXMLnode. Input Parameters filename loadAs StringCompletepathtothefileinthelocalfilesystem.Forexample:
c:\rubicon\document.xml
StringOptional.ForminwhichyouwantgetFiletomakethecontents ofthefileavailabletosubsequentservices. Set to...

bytes
To... Default.Returnthefileasabytearray.Usethisoption ifthecontentsofthefilewillbeusedasinputtoa servicethatoperatesonwholedocuments(for example,pub.xml:queryXMLNode). Returnthefileasaninputstream.Usethisoptionifthe contentsofthefilewillbeusedasinputtoaservice thatcanprocessadocumentincrementally(for example,Usage Notes).
stream
bufferSize
StringOptional.Buffersize(inbytes)touseifyouareloadingan InputStream(thatis,loadAs=stream).Thedefaultis4096bytes.For example:1024
Output Parameters body DocumentDocument(IDataobject)containingthefileasabyte[]or anInputStream.bodywillcontainoneofthefollowingkeys, dependingonhowloadAswasset:
188
9 File Folder
Key
bytes
Description byte[ ] Conditional.Filecontentsinabytearray(if loadAsissettobytes.) java.io.InputStreamConditional.Filecontentsasan InputStream(ifloadAsissettostream).
stream
Usage Notes getFiledoesnotautomaticallygenerateanXMLnodefromthecontentsofthefile.To generateanXMLnode,passtheoutputfromthisservicetopub.xml:xmlStringToXMLNode. See Also pub.io:close
189
9 File Folder
190
10
Flow Folder
Youusetheelementsintheflowfoldertoperformdebuggingandutilitytypetasksina flowservice.
191
10 Flow Folder

Thefollowingelementsareavailableinthisfolder: Element pub.flow:clearPipeline Package and Description WmPublic.Removesallfieldsfromthepipeline.You mayoptionallyspecifyfieldsthatshouldnotbe clearedbythisservice. WmPublic.Writesamessagetotheserverlog. WmPublic.Obtainsdetailedinformationaboutthelast exceptionthatwastrappedwithinaflow. WmPublic.Retrievestheretrycountandthe maximumretrycountforaservice. WmPublic.Retrievesinformationabouttheprotocol fromwhichthecurrentservicewasinvoked. WmPublic.Retrievesinformationabouttheprotocol fromwhichthecurrentservicewasinvoked. WmPublic.Restoresapipelinepreviouslysavedby pub.flow:savePipeline. WmPublic.Restoresapipelinethatwaspreviously savedtoafile. WmPublic.Savesapipelineintomemory,forlater retrievalwithpub.flow:restorePipeline. WmPublic.Savesthecurrentpipelinetoafileonthe machinerunningwebMethodsIntegrationServer. WmPublic.Forcesaspecifiedresponsestringtobe returnedbythewebMethodsIntegrationServertoa callingprocess(suchasabrowserorapplication server). WmPublic.SpecifiestheHTTPresponsecodetobe returnedbyIntegrationServertoacallingprocess (suchasabrowserorapplicationserver). WmPublic.ThrowsanISRuntimeExceptionand instructstheIntegrationServertoreexecuteaservice usingtheoriginalserviceinput. WmPublic.Writesthenamesandvaluesofallfieldsin thepipelinetotheserverlog. WmPublic.Documenttypeusedtoreturninformation abouttheprotocolthroughwhichaservicewas invoked.
pub.flow:debugLog pub.flow:getLastError pub.flow:getRetryCount pub.flow:getSession pub.flow:getTransportInfo pub.flow:restorePipeline pub.flow:restorePipelineFromFile pub.flow:savePipeline pub.flow:savePipelineToFile pub.flow:setResponse
pub.flow:setResponseCode
pub.flow:throwExceptionForRetry
pub.flow:tracePipeline pub.flow:transportInfo
192
10 Flow Folder
pub.flow:clearPipeline
WmPublic.Removesallfieldsfromthepipeline.Youmayoptionallyspecifyfieldsthat shouldnotbeclearedbythisservice. Input Parameters preserve Output Parameters None. String List Optional.Fieldnamesthatshouldnotbeclearedfromthe pipeline.
pub.flow:debugLog
WmPublic.Writesamessagetotheserverlog. Eachlogmessagecontainsatimestamp,amessageID,thefunctionnamefield,and messagefield.Thefollowingisanexample:
function 2002-08-16 11:01:23 EDT [ISP.0090.0004C] My function My message message
Input Parameters message function level StringOptional.Textofthemessagetowritetothelog. StringOptional.Functionname,typicallyanabbreviationusedto identifythesourceofthemessage. StringOptional.Debuglevelatwhichtodisplaythismessage. WhetherornotIntegrationServerdisplaysthismessagedependson thelogginglevelsettingforthe0090pubFlowservicesfacility.For example,ifyouspecifyErrorforthismessage,but0090pubFlow servicesfacilityisconfiguredtodisplayonlyFatalerrors,this messagewillnotbedisplayed.However,ifthe0090pubFlow servicesloggingfacilitylogginglevelissettoWarn,thismessage willbedisplayed(theWarnsettingdisplayswarning,error,andfatal messages). Specifyoneofthefollowingvalues: Specify...
Off Fatal
To display the message with these types of messages... Nomessages. Fatalmessagesonly.Thisisthedefault
193
10 Flow Folder
Error Warn Info Debug
Errorandfatalmessages. Warning,error,andfatalmessages. Informational,warning,error,andfatalmessages.. Debug,informational,warning,error,andfatal messages. Trace,debug,informational,warning,error,andfatal messages.
Trace
ThedefaultisFatal. Output Parameters None. Usage Notes Youcancontrolthelogginglevelforflowmessagesindependentoflogmessagesfor otherfacilities.OntheSettings > Logging > EditscreeninIntegrationServer Administrator,navigatetofacility0090 pub Flow Servicesandspecifythelevelof messagesthatyouwantIntegrationServertodisplayforservicesinthepub.flowfolder. PriortoIntegrationServer7.1,IntegrationServerusedanumberbasedsystemtoset thelevelofdebuginformationwrittentotheserverlog.IntegrationServermaintains backwardcompatibilitywiththissystem.
pub.flow:getLastError
WmPublic.Obtainsdetailedinformationaboutthelastexceptionthatwastrapped withinaflow. AnexceptionistrappedinaflowwhenaservicefailureoccursinsideaSEQUENCEstep thatexecutesuntilDONE,orwhenaservicefailureoccursinsideaREPEATstepthat repeatsonFAILURE. Input Parameters None. Output Parameters lastError DocumentInformationaboutthelasterror,translatedintothe languageusedbytheIntegrationServer.Thestructureofthis documentisdefinedbypub.event:exceptionInfo.
194
10 Flow Folder
Usage Notes Ifthisserviceisnotinvokedfromwithinaflowservice,anexceptionisthrown. Eachexecutionofaservice(whethertheservicesucceedsorfails)updatesthevalue returnedbygetLastError.Consequently,getLastErroritselfresetsthevalueoflastError. Therefore,iftheresultsofgetLastErrorwillbeusedasinputtosubsequentservices, mapthevalueoflastErrortoavariableinthepipeline. Ifamaphasmultipletransformers,thenasubsequentcalltogetLastErrorwillreturn theerrorassociatedwiththelastfailedtransformerinthemap,evenifitisfollowed bysuccessfultransformers.
pub.flow:getRetryCount
WmPublic.Retrievestheretrycountandthemaximumretrycountforaservice. TheretrycountindicatesthenumberoftimestheIntegrationServerhasreexecuteda service.Forexample,aretrycountof1indicatesthattheIntegrationServertriedto executetheservicetwice(theinitialattemptandthenoneretry).Themaximumretry countindicatesthemaximumnumberoftimestheIntegrationServercanreexecutethe serviceifitcontinuestofailbecauseofanISRuntimeException. Input Parameters None. Output Parameters retryCount maxRetryCount String ThenumberoftimestheIntegrationServerhasreexecutedthe service. StringThemaximumnumberoftimestheIntegrationServercanre executetheservice.Avalueof1indicatesthattheserviceisbeing invokedbyatriggerconfiguredtoretryuntilsuccess.
Usage Notes Althoughthepub.flow:getRetryCountservicecanbeinvokedatanypointinaflow service,thepub.flow:getRetryCountserviceretrievesretryinformationfortheservice withinwhichitisinvoked.Thatis,youcanusethepub.flow:getRetryCountserviceto retrieveretryinformationfortoplevelservicesorservicesinvokedbyatriggeronly. Thepub.flow:getRetryCountservicedoesnotretrieveretryinformationforanested service(aservicethatisinvokedbyanotherservice). TheIntegrationServerretriesaservicethatisconfiguredtoretryiftheserviceuses thepub.flow:throwISRuntimeExceptionservicetocatchatransienterrorandrethrowitas anISRuntimeException.TheIntegrationServerwillalsoretryaservicewrittenin Javaiftheservicethrowsanexceptionusing com.wm.app.b2b.server.ISRuntimeException().Formoreinformationabout
195
10 Flow Folder
constructingcom.wm.app.b2b.server.ISRuntimeExceptionsinJavaservices,seethe webMethodsIntegrationServerJavaAPIReferenceforthe com.wm.app.b2b.server.ISRuntimeExceptionclass. ThemaximumnumberoftimestheIntegrationServerretriesaservicedependson thevalueoftheMax attemptspropertyfortheservice.Iftheserviceisinvokedbya trigger,theretrybehaviorisdeterminedbythetriggerretryproperties. See Also pub.flow:throwExceptionForRetry
pub.flow:getSession
WmPublic.InsertstheSessionobjectintothepipelineasadocumentnamed$session. Sessionisusefulforassociatingvalueswithparticularclientsorusers.Once$sessionis addedtothepipeline,itcanbeusedlikeanyotherdocumentinaflow.Thispermitsmore powerfulflowsthatperformworkspanningseveraluserrequests. Input Parameters None. Output Parameters $session DocumentInformationforthecurrentusersession.Setting,copying, ordroppingfieldswithin$sessioniseffectivelymanipulatingthe Sessionobjectontheserver.
pub.flow:getTransportInfo
WmPublic.Retrievesinformationabouttheprotocolfromwhichthecurrentservicewas invoked. Input Parameters None. Output Parameters transport DocumentInformationabouttheprotocolthatinvokedtheservice. Thestructureofthisdocumentisdefinedbypub.flow:transportInfo.
196
10 Flow Folder
Usage Notes Thevalueoftheprotocolkeyintransportindicateswhichprotocolwasusedtoinvoked theservice.Forexample,iftheservicewasinvokedviatheemailprotocol,protocol wouldbesettoemail.transportwillalsocontainadocument(whosekeyisprotocol dependent)thatholdsprotocolspecificdetails. Tousethisservice,firstcheckthevalueoftheprotocolparametertodeterminewhich protocolhadbeenused.Then,dependingonthevalueofprotocol,extractthe appropriateprotocolinformationfromtransport.Seepub.flow:transportInfoforthe structureofthedocumentthatholdstheprotocoldetails.
pub.flow:restorePipeline
WmPublic.Restoresapipelinepreviouslysavedbypub.flow:savePipeline. Input Parameters $name StringNameofthesavedpipeline.Becausemultiplepipelinescanbe saved,thisparameterisnecessarytoidentifythepipelinein memory.Ifthisvalueisleftnullorthenameisunknown,an exceptionwillbethrown. StringOptional.Flagthatindicateswhetherornottomergethe valuesintheexistingpipelinewiththevaluesinthesavedpipeline. Set to...
false
$merge
To... Default.Cleartheexistingpipelinebeforerestoringthe savedpipeline. Mergetheexistingpipelinewiththesavedpipeline.Ifa fieldexistsinthesavedpipelineandtheexisting pipeline,thesavedfieldtakesprecedence.
true
$remove
StringOptional.Flagthatindicateswhetherornotthesavedpipeline willremaininmemoryafterthisserviceisexecuted. Set to...

false
To... Default.Retainthesavedpipelineinmemorysothat futurecallstorestorePipelinewiththesame$namewillstill returnthesavedpipeline. Removethesavedpipelinefrommemoryafterthe serviceexecutes.
true
Output Parameters Theoutputisdynamic,basedonthecontentsofthesavedandexistingpipelines.
197
10 Flow Folder
Usage Notes AfterasuccessfulinvocationofrestorePipeline,thepipelinewillcontainallfieldsthat werepresentimmediatelybeforepub.flow:savePipelinewasinvoked.restorePipeline clears existingpipelinevaluesunlesstheoptional$mergefieldisspecified. Thisserviceishelpfulintheinteractivedevelopmentordebuggingofanapplication. See Also pub.flow:savePipeline pub.flow:restorePipelineFromFile
pub.flow:restorePipelineFromFile
WmPublic.Restoresapipelinethatwaspreviouslysavedtoafile. Input Parameters fileName StringRelativepathandfilenameofafilecontainingasaved pipelineontheIntegrationServer.Ifthefileisnotfoundatruntime, anexceptionisthrown. StringOptional.Flagthatdetermineswhetherornottomergethe savedvaluesintotheexistingpipeline. Set to...
false
merge
To... Default.Replacetheexistingpipelinewiththesaved values. Mergethesavedvaluesintotheexistingpipeline.
true
Output Parameters Theoutputisdynamic,basedonthecontentsofthesavedandexistingpipelines. Usage Notes Thisserviceishelpfulintheinteractivedevelopmentordebuggingofanapplication. Beawarethatvariablesthatexistinthesavedpipelinebutarenotdefinedintheflow willnotappearonthePipelinetaband,therefore,willnotbeavailableforexplicit mapping. See Also pub.flow:savePipelineToFile pub.flow:restorePipeline
198
10 Flow Folder
pub.flow:savePipeline
WmPublic.Savesapipelineintomemory,forlaterretrievalwithpub.flow:restorePipeline. Input Parameters $name Output Parameters None. Usage Notes AfterasuccessfulinvocationofsavePipeline,asnapshotofallpipelinefieldswillbe savedinmemoryunderthekeyprovidedby$name.Notethatsincethepipelineis savedtomemory,itwillnotbeavailableafteraserverrestart. Thisserviceishelpfulintheinteractivedevelopmentordebuggingofanapplication. See Also pub.flow:restorePipeline pub.flow:savePipelineToFile StringNamethatwillidentifythepipelineinmemory.Anexception willbethrownifthisvalueisnotspecified.
pub.flow:savePipelineToFile
WmPublic.SavesthecurrentpipelinetoafileonthemachinerunningwebMethods IntegrationServer. Input Parameters fileName StringRelativepathtoafileonwebMethodsIntegrationServerin whichtosavethecontentsofthepipeline.Ifthefiledoesnotexist, theservicecreatesit.Ifthefilealreadyexists,theserviceoverwrites it.
Output Parameters None. Usage Notes Thisserviceishelpfulintheinteractivedevelopmentordebuggingofanapplication. See Also pub.flow:restorePipelineFromFile pub.flow:savePipeline
199
10 Flow Folder
pub.flow:setResponse
WmPublic.ForcesaspecifiedresponsestringtobereturnedbythewebMethods IntegrationServertoacallingprocess(suchasabrowserorapplicationserver). Formattingoftheresponseisnormallyhandledbytemplates,whichformatvaluesfrom thepipeline.Iftemplatesarenotappropriateforaparticularintegrationscenario,a responsemessagecanbecreatedwithintheflowandthenreturnedtothecallerusing thisservice. TypicalusageofthisserviceistocreateanXMLresponsetoanXMLrequest.Aflowthat createsanXMLdocumentbycallingpub.xml:documentToXMLStringcanuse pub.flow:setResponsetoreturntheXMLdocumenttothecaller.Inyourflow,youwould mapxmldata(outputofpub.xml:documentToXMLString)toresponse(inputtosetResponse). CallingsetResponsewillcausetheservertoreturntheXMLdocumentthatyouve mappedtoresponseinsteadofprocessingthepipelinethroughatemplate. Input Parameters response contentType StringResponsetobereturnedtothecaller. StringOptional.MIMEtypeoftheresponsedata.Bydefault,the serversresponsewillmatchtheMIMEtypeoftherequest.Thisfield allowsthisbehaviortobeoverridden. Note: IfyouexplicitlysetthisvaluewithDeveloper,youwillseetwo choices:text/XMLandtext/HTML.Youarenotlimitedtothesetwo values.Youmayeitherselectoneoftheseortypeanewvalue. encoding Output Parameters None. Usage Notes IntegrationServerdetectsthetypeofrequestandsetstheContentTypevalueto text/XML(forrequestsinXMLformat)ortext/HTML(forrequestsinallotherformats). BeawarethatifyouspecifyavalueforcontentType,Developerwillnotbeableto decodeordisplayoutputfromflowsthatincludethisservice.Thisisbecauseyour contentTypesettingwilloverridetheContentTypevaluethattheIntegrationServer usestoreturnoutputtoDeveloper.IfyouuseRuntotesttheflow,Developerwillnot displayanyresults.Instead,youwillreceiveanerrormessage.Therefore,ifyou includethisserviceinaflowandyouwanttotesttheflowfromDeveloper,usethe Run in Browsercommand. KeepinmindthatwhenreturningtheprocessedXMLdocumenttotheclientthat originallysubmittedit,youmayneedtomodifytheencoding.JavaStringobjectsare alwaysstoredusingaUnicodeencoding.IfyouroriginalXMLdocumentusedan encodingotherthanUTF8orUTF16,itwillstillcontainanencodingtagthat StringOptional.Charactersetinwhichtheresponseisencoded.
200
10 Flow Folder
indicateswhatthisencodingwas.However,ifyoudidnotmodifytheencoding duringdocumentprocessing,youneedtosettheencodingparameterwhenyou invokethepub.flow:setResponseservice.Specifically,dooneofthefollowing: Settheencodingparametertomatchthetaginthefile,or SettheencodingparametertoautoDetecttousetheencodingspecifiedinthe XMLstringencodingtag.
pub.flow:setResponseCode
WmPublic.SpecifiestheHTTPresponsecodetobereturnedbyIntegrationServertoa callingprocess(suchasabrowserorapplicationserver). Input Parameters responseCode StringHTTPstatuscodetobereturnedtothecaller. TheresponseCodeparametercanbesettooneofthefollowing: 100,101,200,201,202,203,204,205,206,300,301, 302,303,304,305,306,307,400,401,402,403,404, 405,406,407,408,409,410,411,412,413,414,415, 416,417,500,501,502,503,504,505 Output Parameters None.
pub.flow:throwExceptionForRetry
WmPublic.ThrowsanISRuntimeExceptionandinstructstheIntegrationServertore executeaserviceusingtheoriginalserviceinput. Input Parameters wrappedException ObjectOptional.Anyexceptionthatyouwanttoincludeaspartof thisISRuntimeException.Thismightbetheexceptionthatcauses thepub.flow:throwExceptionForRetryservicetoexecute.Forexample,if theserviceattemptstoconnecttoadatabaseandtheconnection attemptfails,youmightmaptheexceptiongeneratedbythe databaseconnectionfailuretothewrappedExceptionparameter. StringOptional.Amessagetobeloggedaspartofthisexception.
message Output Parameters None.
201
10 Flow Folder
Usage Notes Usethepub.flow:throwExceptionForRetryservicetohandletransienterrorsthatmight occurduringserviceexecution.Atransienterrorisanerrorthatarisesfroma conditionthatmightberesolvedquickly,suchastheunavailabilityofaresourcedue tonetworkissuesorfailuretoconnecttoadatabase.Theservicemightexecute successfullyiftheIntegrationServerwaitsandthenretriestheservice.Ifatransient erroroccurs,theservicecancatchthiserrorandinvokepub.flow:throwExceptionForRetryto instructtheIntegrationServertoretrytheservice. Thepub.flow:throwExceptionForRetryserviceshouldbeusedfortransienterrorsonly. Onlytoplevelservicesortriggerservicescanberetried.Thatis,aservicecanbe retriedonlywhenitisinvokeddirectlybyaclientrequestorbyatrigger.Theservice cannotberetriedwhenitisinvokedbyanotherservice(thatis,whenitisanested service). Youcaninvokethepub.flow:getRetryCountservicetoretrievethecurrentretrycountand themaximumspecifiedretryattemptsforaservice. IfthetriggerserviceiswritteninJava,theservicecanuseISRuntimeException()to throwanexceptionandretrytheservice.Formoreinformationaboutconstructing ISRuntimeExceptionsinJavaservices,seethewebMethodsIntegrationServerJavaAPI Referenceforthecom.wm.app.b2b.server.ISRuntimeExceptionclass. Forinformationaboutconfiguringretryforservices,seewebMethodsDeveloperUsers Guide.Formoreinformationaboutconfiguringretryfortriggers,seethePublish SubscribeDevelopersGuide. See Also pub.flow:getRetryCount
pub.flow:tracePipeline
WmPublic.Writesthenamesandvaluesofallfieldsinthepipelinetotheserverlog. Input Parameters level StringOptional.Debuglevelatwhichtowritethepipeline.Defaults toFatal.IfthedebuglevelonthewebMethodsIntegrationServeris settoavaluelessthanthisparameter,thepipelinewillnotbe writtentotheserverlog.
Output Parameters None. Usage Notes PriortoIntegrationServer7.1,IntegrationServerusedanumberbasedsystemtoset thelevelofdebuginformationwrittentotheserverlog.IntegrationServermaintains
202
10 Flow Folder
backwardcompatibilitywiththissystem.Formoreinformationaboutlogginglevels, seethedescriptionofthewatt.debug.levelparameterinthewebMethodsIntegration ServerAdministratorsGuide.
pub.flow:transportInfo
WmPublic.Documenttypeusedtoreturninformationabouttheprotocolthroughwhich aservicewasinvoked. Parameters protocol String NameofprotocolaboutwhichtransportInfocontains information.Willbeoneofthefollowingvalues: A value of...
email
Indicates that... Theemailprotocolwasusedtoinvokethe service.Detailedinformationiscontainedinthe emailparameter. Thehttpprotocolwasusedtoinvoketheservice. Detailedinformationiscontainedinthehttp parameter. Theftpprotocolwasusedtoinvoketheservice. Detailedinformationiscontainedintheftp parameter. Thefilepollingprotocolwasusedtoinvokethis service.Detailedinformationiscontainedinthe filePollingparameter. Indicates that... TheservicewasinvokedthroughHTTP. TheservicewasinvokedthroughHTTPS.
http
ftp
filePolling
subprotocol
StringConditional.HTTPsubprotocolasfollows: A value of...

HTTP HTTPS
Thisparameterisreturnedonlywhentheservicewasinvokedvia HTTP. email DocumentConditional.Informationabouttheemailtransport. Returnedonlyiftheemailtransportinvokedtheservice. Key to from Description String List Emailaddressesfortherecipientsofthe email. String List Emailaddressesforthesendersofthe email.
203
10 Flow Folder
cc bcc replyto subject filename contenttype content recvdate
String List Conditional.Emailaddressesreceiving acopyoftheemail. String List Conditional.Emailaddressesreceiving ablindcopyoftheemail. String List Conditional.Emailaddresstowhich repliesofthisemailshouldbesent String Subjectoftheemail. String Conditional.Nameoftheattachedfile. String Conditional.ContentTypeoftheattached file. java.io.InputStreamConditional.Contentsofthe attachedfile. StringConditional.Datetheemailwasreceivedin Stringformat.recvdatemaybepassedas parameterforthejava.util.Dateconstructor. StringConditional.Datetheemailwassentin Stringformat.sentdatemaybepassedas parameterforthejava.util.Dateconstructor.
sentdate
http
DocumentConditional.Informationaboutthehttptransport. Returnedonlyiftheservicewasinvokedviahttp. Key requestUrl query requestHdrs Description StringURLusedbyclienttoinvoketheservice. StringConditional.Queryportionofrequest URL. DocumentFieldsintherequestheader,wherekey namesrepresentheaderfieldnamesandvalues representtheheaderfieldvalues. DocumentInformationaboutthehttpsocket connectionhasalocalIaddressandaremoteip address(portalso).Containsthefollowing information: Key localIp localPort remoteIp Description StringLocalIPaddressforthis socketconnectiontoclient. StringLocalportnumberforthis socketconnectiontoclient. StringRemoteIPaddressforthis socketconnectiontoclient.
ipInfo
204
10 Flow Folder
remotePort ftp
StringRemoteportnumberfor thissocketconnectiontoclient.
DocumentConditional.Informationabouttheftptransport. Returnedonlyiftheftptransportinvokedtheservice. Key filename mimetype Description StringNameoffilethatwasputintotheservice directory. StringConditional.Contenttypeofthefile(for example,text/xml,text/plain,orimage/jpeg). Theserverdeterminescontenttypebasedonthe extensionofthefileandtheextensions correspondingcontenttypedefinedin IntegrationServer_directory\lib\mime.types.
filePolling
DocumentConditional.Informationaboutthefilepollingtransport. Returnedonlyifthefilepollingtransportinvokedtheservice. Key filename originalFilename contenttype Description StringFullyqualifiednameofthefilesubmitted tothefilepollinglistener. StringNameofthefilewhenitwassubmittedto thefilepollinglistener. StringConditional.Contenttypeofthefile(for example,text/xml,text/plain,orimage/jpeg). Theserverdeterminescontenttypebasedonthe extensionofthefileandtheextensions correspondingcontenttypedefinedin IntegrationServer_directory\lib\mime.types. StringTheoriginalfilelengthinbytes. ObjectJavadateobject(java.util.Date)indicating whentheoriginalfilewaslastmodified.
length lastModified Usage Notes
Adocumentwiththisstructureisoutputbythepub.flow:getTransportInfoservice.
205
10 Flow Folder
206
11
IO Folder
Youusetheelementsintheiofoldertoconvertdatabetweenbyte[]andInputStream representations.Theseservicesbehavelikethecorrespondingmethodsinthe java.io.InputStreamclass.FormoreinformationaboutInputStreams,seetheJava documentation.
207
11 IO Folder

Note: Theservicesinthisfoldermayonlybeinvokedbyotherservicesonthe IntegrationServer.StreamscannotbepassedbetweenclientsandtheIntegration Server,sotheseserviceswillnotexecuteiftheyareinvokedfromaclient. Thefollowingelementsareavailableinthisfolder: Element pub.io:bytesToStream pub.io:close pub.io:createByteArray pub.io:mark pub.io:markSupported pub.io:read pub.io:reset Package and Description WmPublic.Createsajava.io.ByteArrayInputStreamfrom abyte[]. WmPublic.Closesajava.io.InputStreamobject. WmPublic.Createsabytearrayofthespecifiedlength. WmPublic.Marksthecurrentpositioninthe InputStream. WmPublic.EnablesyoutotestwhetheryourInputStream supportsthemarkandresetoperations. WmPublic.Readsanumberofbytesfromthe InputStreamandstoresthemintoabuffer. WmPublic.RepositionstheInputStreamtothepositionat thetimethepub.io:markservicewaslastinvokedonthe stream. WmPublic.Skipsoveranddiscardsthespecifiednumber ofbytesfromthisInputStream. WmPublic.Createsabyte[]fromdatathatisreadfrom anInputStream.
pub.io:skip pub.io:streamToBytes
pub.io:bytesToStream
WmPublic.Createsajava.io.ByteArrayInputStreamfromabyte[]. Input Parameters bytes Output Parameters stream java.io.ByteArrayInputStreamAnopenInputStreamcreatedfromthe contentsofbytes. byte[ ]Thebytearraythatyouwanttoconvert.
208
11 IO Folder
Usage Notes Thisserviceconstructsstreamfromthebytearrayusingtheconstructor ByteArrayInputStream(byte[]).Thisconstructordoesnotmakeacopyofthebyte array,soanychangestobyteswillbereflectedinthedatareadfromthestream.
pub.io:close
WmPublic.ClosestheInputStream. Input Parameters stream Output Parameters None. Usage Notes IftheInputStreamisalreadyclosed,invokingthisservicehasnoeffect.However,leaving anInputStreamopenmaycauseerrorsthatarenotrecoverableuntiltheIntegration Serverisshutdown.Usethepub.io:closeservicetoexplicitlyclosetheInputstreamwhena serviceleavesitopen.Forexample,pub.file:getFileandpub.client.ftp:getleavetheInputStream openinthepipeline. java.io.InputStreamAnopenInputStream.
pub.io:createByteArray
WmPublic.Createsabytearrayofthespecifiedlength. Input Parameters length Output Parameters bytes Usage Notes Thepub.io:readservicereadsdatafromanInputStreamintoabytearray.Youcanuse thisservicetocreatethebytearray.InvokingthisserviceistheequivalentoftheJava codenew byte[length]. ObjectThenewbytearray. String Thelengthofthebytearraytobecreated.
209
11 IO Folder
pub.io:mark
WmPublic.MarksthecurrentpositionintheInputStream. Asubsequentcalltopub.io:resetrepositionsthisstreamatthelastmarkedpositionsothat subsequentreadsrereadthesamebytes. Input Parameters stream limit ObjectTheInputStream. StringThemaximumnumberofbytesthatcanbereadbeforethe markpositionbecomesinvalid.Ifmorethanthisnumberofbytes arereadfromthestreamafterthemarkserviceisinvoked,the pub.io:resetservicewillhavenoeffect.
Output Parameters stream Usage Notes IftheInputStreamdoesnotsupportthemarkoperation,invokingthisservicehasno effect. ObjectTheInputStream.
pub.io:markSupported
WmPublic.EnablesyoutotestwhetheryourInputStreamsupportsthemarkandreset operations. Input Parameters stream Output Parameters stream supported ObjectTheInputStream. String Set to ...
true
ObjectTheInputStream.
If ... TheInputStreamsupportsthemarkandreset operations. TheInputStreamdoesnotsupportthemarkandreset operations.
false
210
11 IO Folder
pub.io:read
WmPublic.ReadsanumberofbytesfromtheInputStreamandstoresthemintoabuffer. Input Parameters stream offset length ObjectTheInputStream.Thisserviceattemptstoreadbytesfromthis objectandstorethemintobuffer. String(optional)Theoffsetintothebytearrayinthebuffertowhich thedataiswritten.Ifnovalueissupplied,thisdefaultsto0. String(optional)Themaximumnumberofbytestoreadfromthe InputStream.Ifnovalueissupplied,thedefaultisthelengthof buffer. Ifthevaluesuppliedforlengthisgreaterthanthelengthofbuffer, andtherearemorebytesremaininginstreamthanthelengthof buffer,anexceptionwillbethrown. buffer Output Parameters stream buffer bytesRead ObjectTheInputStream.Ifanybyteswerereadfromthestream,the streamisrepositionedafterthelastbyteread. ObjectThebufferintowhichdatawasread. StringThenumberofbytesreadfromtheInputStreamandcopiedto buffer.Ifthereisnomoredatabecausetheendofthestreamhasbeen reached,bytesReadwillbe1. ObjectThebufferintowhichdataisread.Thisisabytearray,which canbecreatedfromaFlowservicebyinvokingpub.io:createByteArray.
pub.io:reset
WmPublic.RepositionstheInputStreamtothepositionatthetimethepub.io:markservice waslastinvokedonthestream. Input Parameters stream Output Parameters stream ObjectTheInputStream. ObjectTheInputStream.
211
11 IO Folder
Usage Notes IftheInputStreamdoesnotsupporttheresetoperation,invokingthisservicehasno effect.
pub.io:skip
WmPublic.SkipsoveranddiscardsthespecifiednumberofbytesfromthisInputStream. Input Parameters stream length Output Parameters stream bytesSkipped Usage Notes The pub.io:skipserviceusestheInputStream.skipmethod,whichmight,foravarietyof reasons,skipsomesmallernumberofbytes,possiblyzero(0).Thismightresultfrom anynumberofconditions(reachingtheendoffilebeforenbyteshavebeenskippedis onlyonepossibility).SeetheJavadocumentationontheInputStreamclass. ObjectTheInputStream. StringTheactualnumberofbytesthatwereskipped. ObjectTheInputStream. StringThenumberofbytestoskip.
pub.io:streamToBytes
WmPublic.Createsabyte[]fromdatathatisreadfromanInputStream. Input Parameters stream Output Parameters bytes Usage Notes Thisservicereadsallofthebytesfromstreamuntiltheendoffileisreached,andthen itclosestheInputStream. byte[ ] Thebytesreadfromstream. java.io.InputStreamTheInputStreamthatyouwanttoconvert.
212
12
JMS Folder
YoucanusetheservicesintheJMSfoldertosendandreceiveJMSmessages.
213
12 JMS Folder
Summary of Elements in This Folder

Thefollowingelementsareavailableinthisfolder: Element pub.jms:acknowledge pub.jms:batchTriggerSpec pub.jms:createConsumer pub.jms:documentResolverSpec Package and Description WmPublic.Sendsanacknowledgmentforamessageto theJMSprovider. WmPublic.SpecificationforthesignatureofaJMS triggerthatprocessesabatchofmessagesatonetime. WmPublic.Createsamessageconsumertoreceive messagesfromdestinationsontheJMSprovider. WmPublic.Specificationforthesignatureofadocument resolverservicethatdetermineswhetheraJMSmessage hasastatusofNew,Duplicate,orInDoubt. WmPublic.Documenttypethatrepresentsthestructure andcontentofaJMSmessagereceivedbyaJMStrigger, receivedbytheservicepub.jms:receive,orastheoutputof pub.jms:sendorpub.jms:sendAndWait. WmPublic.Receivesamessagefromaqueueortopicon theJMSprovider. WmPublic.Sendsareplymessagetoarequestingclient. WmPublic.SendsaJMSmessagetotheJMSprovider. WmPublic.SendsarequestintheformofaJMSmessage totheJMSproviderandoptionally,waitsforareply. WmPublic.SpecificationfortheinputsignatureofaJMS triggerthatprocessesonemessageatatime. WmPublic.Retrievesthereplymessageforan asynchronousrequest. WmPublic.Receivesalargemessagestreamfroma queueortopiconthewebMethodsJMSProvider. WmPublic.Sendsalargemessagestreamtothe webMethodsJMSProvider.
pub.jms:JMSMessage
pub.jms:receive pub.jms:reply pub.jms:send pub.jms:sendAndWait pub.jms:triggerSpec pub.jms:waitForReply pub.jms.wmjms:receiveStream pub.jms.wmjms:sendStream
214
12 JMS Folder
pub.jms:acknowledge
WmPublic.SendsanacknowledgmentforamessagetotheJMSprovider. Input Parameters message ObjectAjavax.jms.Messageobjectthatidentifiesthemessagefor whichyouwantIntegrationServertosendanacknowledgementto theJMSprovider.
Output Parameters None. Usage Notes UsethisservicetoacknowledgeamessageretrievedfromtheJMSproviderif: Themessagewasreceivedusingthepub.jms:receiveservice,and ThemessageconsumerusedtoretrievethemessagehasanacknowledgmentMode settoCLIENT_ACKNOWLEDGEorDUPS_OK_ACKNOWLEDGE.Formoreinformationabout creatingamessageconsumer,seepub.jms:createConsumer. Amessageisnotconsideredtobesuccessfullyconsumeduntilitisacknowledged. Note: Acknowledgingamessageautomaticallyacknowledgesthereceiptofall messagesreceivedinthesamesession.Thatis,allmessagesreceivedbythesame consumerwillbeacknowledgedwhenjustoneofthereceivedmessagesis acknowledged. See Also pub.jms:createConsumer pub.jms:receive
pub.jms:batchTriggerSpec
WmPublic.SpecificationforthesignatureofaJMStriggerthatprocessesabatchof messagesatonetime. Input Parameters JMSMessage Output Parameters None. Document ListAdocumentlistwhereeachdocumentreferencesthe pub.jms:JMSMessagedocumenttype.
215
12 JMS Folder
Usage Notes UsethisspecificationasthesignatureforJMStriggerservicesthatwillretrieveand processabatchofmessages. IfyouwanttouseaJMStriggertoretrieveandprocessonemessageatatime,use pub.jms:triggerSpectodeclarethesignatureoftheJMStriggerservice. See Also pub.jms:triggerSpec pub.jms:JMSMessage
pub.jms:createConsumer
WmPublic.Createsamessageconsumertoreceivemessagesfromdestinationsonthe JMSprovider. Input Parameters connectionAliasName StringNameoftheJMSconnectionaliasthatyouwantthe messageconsumertoreceivemessages. TheJMSconnectionaliasindicateshowIntegrationServer connectstotheJMSprovider.AJMSconnectionaliascan specifythatIntegrationServeruseaJNDIprovidertolook upadministeredobjects(connectionfactoriesand destinations)andthenusetheconnectionfactorytocreatea connection.Alternatively,aJMSconnectionaliascanspecify thatIntegrationServerusesthenativewebMethodsAPIto createtheconnectiondirectlyonthewebMethodsJMS Provider. destinationName StringNameorlookupnameoftheDestinationfromwhich youwantthemessageconsumertoreceivemessages. SpecifythelookupnameoftheDestinationobjectwhenthe JMSconnectionaliasusesJNDItoretrieveadministered objects.Specifytheproviderspecificnameofthe DestinationwhentheJMSconnectionaliasusesthenative webMethodsAPItoconnectdirectlytothewebMethods JMSProvider.
216
12 JMS Folder
destinationType
StringOptional.Typeofdestinationfromwhichthemessage consumerreceivesmessages.Specifyoneofthefollowing: Select...

QUEUE
To... Default.Receivemessagessenttoa particularqueue. Receivemessagessenttoa particulartopic.
TOPIC
Note: YouneedtospecifyadestinationTypeonlyifyou specifiedaconnectionAliasNamethatusesthenative webMethodsAPI. acknowledgmentMode StringOptional.Specifiestheacknowledgementmode. Select...

AUTO_ACKNOWLEDGE
To... Default.Automatically acknowledgethemessagewhenitis receivedbythemessageconsumer. Themessageconsumerwill acknowledgethemessagebeforethe messageprocessingcompletes.The JMSprovidercannotredeliverthe messageifIntegrationServer becomesunavailablebefore messageprocessingcompletes. Acknowledgethereceiptofa messagewhentheJMSclient (IntegrationServer)invokes pub.jms:acknowledgeservice. Automatically,lazilyacknowledge thereceiptofmessages,which reducessystemoverheadbutmay resultinduplicatemessagesbeing sent.
CLIENT_ACKNOWLEDGE
DUPS_OK_ACKNOWLEDGE
217
12 JMS Folder
messageSelector
StringOptionalSpecifiesafilterusedtoreceiveasubsetof messagesfromthespecifieddestination.Amessageselector allowsaclienttofilterthemessagesitwantstoreceiveby useofaSQL92stringexpressioninthemessageheader.That expressionisappliedtopropertiesinthemessageheader (nottothemessagebodycontent)containingthevaluetobe filtered. IftheSQLexpressionevaluatestotrue,theJMSprovider sendsthemessagetothemessageconsumer;iftheSQL expressionevaluatestofalse,theJMSproviderdoesnotsend themessage.
durableSubscriberName
StringOptional.Nameofthedurablesubscriberthatyou wantthisservicetocreateontheJMSprovider.Adurable subscribercreatesadurablesubscriptionontheJMS provider.Ifadurablesubscriberofthisnamealreadyexists ontheJMSprovider,thisserviceresumesthepreviously establishedsubscription. Note: ThisparameteronlyapplieswhenthedestinationTypeis settoTOPIC.IfyouselectTOPIC,butdonotspecifya durableSubscriberName,thisservicecreatesanondurable subscriber.IfdestinationTypeissettoQUEUE,thisparameteris ignored.
noLocal
java.lang.BooleanOptional.Flagindicatingwhetherthe messageconsumercanreceivelocallypublishedmessages. IntegrationServerconsidersamessagetobelocalifthe messagewas: SentbythesameIntegrationServer,and SentusingthesameJMSconnectionalias. Specifyoneofthefollowingvalues Set to...

True
To indicate... Theconsumerwillnotreceive locallypublishedmessages. Default.Theconsumercanreceive locallypublishedmessages.
False
Note: ThisparameteronlyapplieswhenthedestinationTypeis settoTOPIC.
218
12 JMS Folder
Output Parameters consumer Usage Notes AmessageconsumerisawebMethodsobjectthatencapsulatestheactual javax.jms.MessageConsumerandjavax.jms.Session. Anymessageconsumerscreatedduringtheexecutionofaservicewillbeclosed automaticallywhentheservicecompletes.Iftheconsumercloseswithout acknowledgingmessages,messagesareimplicitlyrecoveredbacktotheJMS provider. Theuseofpub.jms:createConsumerinconjunctionwithpub.jms:receiveisanalternativeto usingJMStriggers.Usethepub.jms:createConsumerservicetocreateamessage consumer.Usethepub.jms:receivetoactivelyreceivemessagesfromadestinationon theJMSprovider. Tocreateadurablesubscriber,setthedestinationTypetoTOPICandspecifya durableSubscriberName.IfyouselectTOPIC,butdonotspecifyadurableSubscriberName, IntegrationServercreatesanondurablesubscriber. Adurablesubscriptionallowssubscriberstoreceiveallthemessagespublishedona topic,includingthosepublishedwhilethesubscriberisinactive. Ifadurablesubscriptionalreadyexistsforthespecifieddurablesubscriberonthe JMSprovider,thisserviceresumesthesubscription. Anondurablesubscriptionallowssubscriberstoreceivemessagesontheirchosen topic,onlyifthemessagesarepublishedwhilethesubscriberisinactive.Anon durablesubscriptionlaststhelifetimeofitsmessageconsumer. IftheacknowledgmentModefieldissettoCLIENT_ACKNOWLEDGE,youmustacknowledge messagesreceivedbythisconsumertotheJMSproviderusingthepub.jms:acknowledge service. Ifthemessageconsumercreatedbythisservicewillbeusedtoreceivelargemessage streamsfromthewebMethodsJMSProvider,makesuretospecifyan acknowledgmentModeofAUTO_ACKNOWLEDGEorCLIENT_ACKNOWLEDGE.Ifthe acknowledgmentModeisDUPS_OK_ACKNOWLEDGE,themessageconsumercannotbeused toreceivelargemessagestreams. See Also pub.jms:acknowledge pub.jms:receive pub.jms:reply pub.jms:send pub.jms:sendAndWait ObjectAnondemandmessageconsumerobjectusedtoreceive messagesforthespecifieddestination.
219
12 JMS Folder
pub.jms:documentResolverSpec
WmPublic.Specificationforthesignatureofadocumentresolverservicethatdetermines whetheraJMSmessagehasastatusofNew,Duplicate,orInDoubt. Input Parameters uuid StringUniversallyuniqueidentifierforthemessage.Ifthesending clientassignedavaluetotheuuidfieldinthemessage,Integration Serverusestheuuidvaluetoidentifythemessage.Iftheuuidfieldis empty,IntegrationServerusesthevalueoftheJMSMessageIDfield inthemessageheaderastheUUID. StringThenameoftheJMStriggerthatreceivedthemessagewhose statusneedstoberesolved. DocumentThemessagewhosestatusneedstoberesolved.Thisisa documentreference(IData)tothepub.jms:JMSMessagedocumenttype.
triggerName JMSMessage Output Parameters status
StringIndicatesthestatusofthemessage.Thevalueofthisfield determineswhethertheIntegrationServerprocessesorrejectsthe message.Thestatusfieldmusthaveoneofthefollowingvalues. Key

NEW
Description Indicatesthemessageisnewandhasnotbeenprocessed bytheJMStrigger.IntegrationServerinstructstheJMS triggertoprocessthemessage. Indicatesthemessageisaduplicateofonealready processedbytheJMStrigger.IntegrationServer acknowledgesthemessage,butdoesnotexecutethe triggerservice. Indicatesthestatusofthemessageisstillindoubt.The documentresolverservicecouldnotconclusively determinewhethertheJMStriggeralreadyprocessedthe message.IntegrationServeracknowledgesthemessage, butdoesnotexecutethetriggerservice
DUPLICATE
IN_DOUBT
message
StringConditional.Auserspecifiedstringthatindicateswhythe messagestatusisDUPLICATEorIN_DOUBT.IntegrationServerwritesthis messagetothejournallogwhenthemessagehasastatusofDUPLICATE orIN_DOUBT.
Usage Notes Thepub.jms:documentResolverSpecmustbeusedasthesignatureforadocumentresolver serviceusedtodeterminetheprocessingstatusofaJMSmessagereceivedbyaJMS trigger.Forinformationaboutbuildingadocumentresolverserviceandenabling
220
12 JMS Folder
exactlyonceprocessingforaJMSmessage,seethewebMethodsIntegrationServerJMS ClientDevelopersGuide. Usepub.publish:documentResolverSpecasthesignatureforadocumentresolverservice usedtodeterminethestatusofdocumentreceivedaBroker/localtrigger. See Also pub.jms:JMSMessage pub.publish:documentResolverSpec
pub.jms:JMSMessage
WmPublic.DocumenttypethatrepresentsthestructureandcontentofaJMSmessage receivedbyaJMStrigger,receivedbytheservicepub.jms:receive,orastheoutputof pub.jms:sendorpub.jms:sendAndWait. Parameters header DocumentOptional.Document(IDataobject)containingtheheaderofthe JMSmessage. Key JMSCorrelationID Description StringOptional.Auniqueidentifierusedtolink multiplemessagestogether.Often,a JMSCorrelationIDisusedtolinkareplymessage withitsrequestingmessage. java.lang.IntegerOptional.Deliverymodespecifiedat thetimethemessagewassent.Deliverymodecan beoneofthefollowing: Key
PERSISTENT
JMSDeliveryMode
Description Default.IndicatestheJMS providerplacesthemessageina persistentmessagestore, allowingthemessagetobe recoveredintheeventofa resourcefailure. IndicatestheJMSproviderdoes notplacethemessageina persistentstore.Themessage hasnoguaranteeofbeing deliverediftheJMSprovider fails.
NON-PERSISTENT
221
12 JMS Folder
Note: Whensendingamessage,thisvalueis obtainedfromtheJMSMessage/header/deliveryMode inputparameter. JMSDestination JMSExpiration ObjectOptional.Destination(queueortopic)to whichthemessagewassent. java.lang.Long Optional.Timeatwhichthismessage expires.Ifthemessageproducerdidnotspecifya timetolive,theJMSExpirationvalueiszero, indicatingthemessagedoesnotexpire. Note: Whensendingamessage,thisvalueis obtainedfromtheJMSMessage/header/timeToLive inputparameter. JMSMessageID JMSPriority String.Optional.Uniqueidentifierassignedtothis messagebytheJMSprovider. java.lang.IntegerOptional.Definesthemessage priority.JMSdefinesprioritylevelsfrom0to9, with0asthelowestpriorityand9asthehighest. Note: Whensendingamessage,thisvalueis obtainedfromtheJMSMessage/header/priorityinput parameter. JMSRedelivered java.lang.BooleanOptional.FlagindicatingtheJMS providerdeliveredthismessagetotheJMSclient previously. Key
True
Description Indicatesthemessagemayhave beendeliveredinthepast. IndicatestheJMSproviderhas notdeliveredthismessage previously.
False
JMSReplyTo JMSTimestamp JMSType
ObjectOptional.Destinationtowhichareplytothis messageshouldbesent. java.lang.LongOptional.Timeatwhichthemessage wasgiventotheJMSprovider. StringOptional.Messagetypeidentifierspecified bytheclientwhensendingthemessage.
222
12 JMS Folder
properties
Document.Optional.Adocumentcontainingoptionalfieldsaddedtothe messageheader.IntegrationServermayaddthefollowingpropertiesto JMSmessagesitsendsorreceives. Key JMSXDeliveryCount Description java.lang.IntegerOptional.Specifiesthenumberof timestheJMSproviderdeliveredthemessage. MostJMSproviderssetthisvalue. StringOptional.Auniqueidentifierassignedbythe sender.Anactivationisusedtogrouptogether messagesthatwillbereceivedbyaJMStrigger withajoin.AJMStriggercanjointogether messageswiththesameactivation. StringOptional.Auniversallyuniqueidentifierfor themessageassignedbythesender.Integration Servercanusetheuuidforexactlyonceprocessing orforrequest/reply.
activation
uuid
body
DocumentOptionalADocument(IData)contentingtheJMSmessage body.Amessagebodycanbeinoneofthefollowingformatssupported byIntegrationServer: Key string bytes object data Description StringOptional.Messagebodyintheformofa String. primitive typeOptionalMessagebodyintheformof aonedimensionalbytearray. Object.Optional.Messagebodyintheformofa SerializableJavaobject. DocumentOptional.Messagebodyintheformofa document(IDataobject). Note: Thismessageformatcanonlybeusedwhen sendingaJMSmessagefromoneIntegrationServer toanother.WhentheJMSmessageissent,the sendingIntegrationServerencodestheIDataintoa bytearray.WhenthereceivingIntegrationServer receivesthemessage,itdecodesthebytearrayinto IData.
223
12 JMS Folder
message
ObjectOptional.Messagebodyintheformofan actualjavax.jms.Message. Note: WhenaJMSmessageisreceivedusingthe pub.jms:receiveservicethisfieldwillalwaysbe populatedbecausejavax.jms.Messageisrequired foracknowledgingthemessage. Note: Whenreceivingajavax.jms:MapMessageor javax.jms:StreamMessagethisfieldwillbe populated.Thedatacanthenbeprocessedusinga Javaservice.Aflowservicecannotprocessthe messageinitscurrentstate.
Output Parameters None. See Also pub.jms:receive pub.jms:send pub.jms:sendAndWait
pub.jms:receive
WmPublic.ReceivesamessagefromaqueueortopicontheJMSprovider. Input Parameters consumer timeout ObjectAmessageconsumerobjectthatthesessionusestoreceive messagessenttothespecifieddestination. java.lang.LongSpecifiesthetimetowait,inmilliseconds,fora messagetobereceivedfromtheJMSprovider. Ifyouspecify0(zero),theservicewillnotwait. Thedefaultis0(zero).
224
12 JMS Folder
Output Parameters JMSMessage DocumentAdocument(IData)containingtheJMSmessagereceivedby theconsumer. Key header Description DocumentConditional.ADocumentcontainingtheheader fieldsforthereceivedmessage. Key JMSCorrelationID Description StringConditional.Aunique identifierusedtolinkmultiple messagestogether.Often,a JMSCorrelationIDisusedtolinka replymessagewithitsrequesting message. java.lang.IntegerConditional.Delivery modespecifiedatthetimethe messagewassent.
PERSISTENTindicatestheJMS
JMSDeliveryMode
providerplacesthemessageina persistentmessagestore,allowing themessagetoberecoveredinthe eventofaresourcefailure.

NON-PERSISTENTindicatestheJMS
providerdoesnotplacethemessage inapersistentstore.Themessage hasnoguaranteeofbeingdelivered iftheJMSproviderfails. JMSDestination ObjectConditional.Destination (queueortopic)towhichthe messagewassent. java.lang.Long Conditional.Timeat whichthismessageexpires.Ifthe messageproducerdidnotspecifya timetolive,theJMSExpirationvalue iszero,indicatingthemessagedoes notexpire. StringConditional.Uniqueidentifier assignedtothismessagebytheJMS provider.
JMSExpiration
JMSMessageID
225
12 JMS Folder
JMSPriority
java.lang.IntegerConditional.Defines themessagepriority.JMSdefines prioritylevelsfrom0to9,with0as thelowestpriorityand9asthe highest. java.lang.BooleanConditional.Flag indicatingtheJMSprovider deliveredthismessagetotheJMS clientpreviously.

Trueindicatesthemessagemayhave
JMSRedelivered
beendeliveredinthepast.
FalseindicatestheJMSproviderhas notdeliveredthismessage previously.
JMSReplyTo
ObjectConditional.Destinationto whichareplytothismessageshould besent. java.lang.LongConditional.Timeat whichthemessagewasgiventothe JMSprovider. StringConditional.Messagetype identifierspecifiedbytheclient whensendingthemessage.
JMSTimestamp
JMSType
properties
DocumentConditional.ADocumentcontainingoptional fieldsaddedtothemessageheader.IntegrationServermay addthefollowingpropertiestoJMSmessagesitreceives. Key JMSXDeliveryCount Description java.lang.IntegerConditional. Specifiesthenumberoftimesthe JMSproviderdeliveredthemessage. MostJMSproviderssetthisvalue. StringConditional.Aunique identifierassignedbythesending service.AJMStriggerusesthe activationvaluetodetermineifa messagesatisfiesajoin. StringConditional.Auniversally uniqueidentifierforthemessage assignedbythesender.Integration Servercanusetheuuidforexactly onceprocessingorforrequest/reply.
activation
uuid
226
12 JMS Folder
body
DocumentConditional.ADocument(IData)contentingthe JMSmessagebody.Amessagebodycanbeinoneofthe followingformatssupportedbyIntegrationServer: Key string bytes Description StringConditional.Messagebodyin theformofaString. primitive typeConditional.Message bodyintheformofaone dimensionalbytearray. Object.Conditional.Messagebodyin theformofaSerializableJavaobject. DocumentConditional.Message bodyintheformofadocument (IDataobject). Note: Thismessageformatcanonly beusedwhensendingaJMS messagefromoneIntegrationServer toanother.WhentheJMSmessageis sent,thesendingIntegrationServer encodestheIDataintoabytearray. WhenthereceivingIntegration Serverreceivesthemessage,it decodesthebytearrayintoIData. message ObjectConditional.Messagebodyin theformofanactual javax.jms.Message. Note: WhentheJMSmessageis receivedusingthepub.jms:receive servicethisfieldwillalwaysbe populatedbecause javax.jms.Messageisrequiredfor acknowledgingthemessage. Note: Whenreceivinga javax.jms:MapMessageor javax.jms:StreamMessagethisfield willbepopulated.Thedatacanthen beprocessedusingaJavaservice.A flowservicecannotprocessthe messageinitscurrentstate.
object data
227
12 JMS Folder
Usage Notes UsethisservicetoreceiveamessagefromtheJMSproviderondemand.Receivinga messageondemandprovidesmorecontroloverwhenandhowIntegrationServer receivesamessage;however,itmaynotbeasefficientorpracticalasusingaJMS triggertolistenforandthenreceivethemessage. Tolistenformessagesandreceivethemwhentheyareavailable,createaJMStrigger thatlistenstothedestination.FormoreinformationaboutcreatingaJMStrigger,see thewebMethodsIntegrationServerJMSClientDevelopersGuide. Ifthetimeoutperiodelapsesbeforeamessageisreceived,thevalueofJMSMessageis null. Themessageconsumerthatyouusetoreceivethemessagedeterminesthe destinationfromwhichthisservicesreceivesmessagesandtheJMSconnectionalias usedtoreceivethemessages.Youcancreateamessageconsumerobjectusingthe pub.jms:createConsumerservice. Afteryoureceiveamessage,youneedtoinvokeaservicethatprocessesthemessage. IftheacknowledgmentmodeoftheconsumerissettoCLIENT_ACKNOWLEDGE,usethe pub.jms:acknowledgeservicetoacknowledgethemessagetotheJMSprovider. See Also pub.jms:acknowledge pub.jms:createConsumer
228
12 JMS Folder
pub.jms:reply
WmPublic.Sendsareplymessagetoarequestingclient. Input Parameters JMSReplyMessage Document AdocumentrepresentingtheJMSmessagereply. Key header Description DocumentOptional.Adocumentcontainingthe headerofthereplyingJMSmessage. Key deliveryMode Description StringOptional.Specifiesthemessage deliverymodeforthereplymessage. Specifyoneofthefollowing: Select...
PERSISTENT
To... Default.Provide onceandonlyonce deliveryforthe message.The messagewillnotbe lostifaJMS providerfailure occurs. Provideatmost oncedeliveryfor themessage.The messagehasno guaranteeofbeing savedifaJMS providerfailure occurs.
NON_PERSISTENT
priority
java.lang.IntegerOptional.Specifiesthe messagepriority.JMSdefinespriority levelsfrom0to9,with0asthelowest priorityand9asthehighest. Thedefaultis4. java.lang.LongOptional.Lengthof time,inmilliseconds,thattheJMS providersystemretainsthereply message.Thedefaultis0,meaning thatthemessagedoesnotexpire.
timeToLive
229
12 JMS Folder
JMSType properties
StringOptional.Messagetype identifierforthemessage.
DocumentOptional.ADocumentcontainingoptional fieldsaddedtothemessageheader. Key activation Description StringOptional.Auniqueidentifier thatyouwanttoassigntothe message.JMStriggersusethe activationvaluetodetermineifa messagesatisfiesajoin. StringOptional.Auniversallyunique identifierforthemessage.Integration Servercanusetheuuidforexactly onceprocessingorforrequest/reply.
uuid
body
DocumentOptional.ADocumentcontainingtheJMS messagebody.Amessagebodycanbeinoneofthe followingformatssupportedbyIntegrationServer: Key string bytes Description StringOptional.Messagebodyinthe formofaString. primitive typeOptionalMessagebody intheformofaonedimensionalbyte array. Object.Optional.Messagebodyinthe formofaSerializableJavaobject. DocumentOptional.Messagebodyin theformofadocument(IDataobject). Note: Thismessageformatcanonlybe usedwhensendingaJMSmessage fromoneIntegrationServerto another.WhentheJMSmessageis sent,thesendingIntegrationServer encodestheIDataintoabytearray. WhenthereceivingIntegrationServer receivesthemessage,itdecodesthe bytearrayintoIData. message ObjectOptional.Messagebodyinthe formofajavax.jms.Message.
object data
230
12 JMS Folder
consumer
ObjectOptional.Themessageconsumerobjectusedtoreceivethe requestmessagefromtheJMSprovider.IntegrationServeruses informationfromtheconsumertocreateamessageproducerthat willsendthereplymessage. Youonlyneedtospecifyaconsumerwhenreplyingtoamessage receivedusingpub.jms:receive.
message
ObjectOptional.Ajavax.jms.Messageobjectthatcontainsthe requestmessage.YoucanmaptheJMSMessage/body/messagefield intherequestmessagetothepub.jms:replymessageinputparameter. Thepub.jms:reply serviceusestherequestmessagetodeterminethe replyTodestination. Youonlyneedtospecifyamessagewhenreplyingtoamessage receivedusingpub.jms:receive.
Output Parameters JMSReplyMessage Document.ADocumentcontainingthereplymessagetheJMS providersenttotheclient.Afteritsendsamessage,theJMS providerpopulatessomefieldsintheJMSreplymessage. Key header Description DocumentConditional.ADocumentcontainingthe headerfieldsforthereplymessage. JMSCorrelationID StringConditional.Aunique identifierusedtolinkthereply messagewiththeinitialrequest message. ThereplyingIntegrationServer automaticallysetsthisvaluewhen itexecutesthepub.jms:replyservice. JMSDeliveryMode java.lang.IntegerDeliverymode usedtosendthemessage.
PERSISTENTindicatesthattheJMS
providerprovidesonceandonly oncedeliveryforthemessage.The messagewillnotbelostifaJMS providerfailureoccurs.
231
12 JMS Folder
NON_PERSISTENTindicatesthatthe
JMSproviderprovidesatmost oncedeliveryforthemessage.The messagehasnoguaranteeofbeing savedifaJMSproviderfailure occurs. Note: Whensendingareply message,thisvalueisobtained fromthe JMSMessage/header/deliveryMode inputparameter. JMSDestination ObjectConditional.Destination (queueortopic)towhichthe messagewassent.TheJMSReplyTo valueoftherequestmessage determinesthedestinationofthe replymessage. java.lang.Long Conditional.Timeat whichthismessageexpires.Ifthe messageproducerdidnotspecify atimetolive,theJMSExpiration valueiszero,indicatingthe messagedoesnotexpire. Note: Whensendingamessage, thisvalueisobtainedfromthe JMSReplyMessage/header/timeToLive inputparameter. JMSMessageID StringConditional.Unique identifierassignedtothismessage bytheJMSprovider. java.lang.IntegerConditional. Definesthemessagepriority.JMS definesprioritylevelsfrom0to9, with0asthelowestpriorityand9 asthehighest. Note: Whensendingareply message,thisvalueisobtained fromthe JMSMessage/header/priorityinput parameter.
JMSExpiration
JMSPriority
232
12 JMS Folder
JMSReplyTo
ObjectConditional.Specifiesthe destinationtowhicharesponseto thismessageshouldbesent. java.lang.LongTimeatwhichthe messagewasgiventotheJMS provider. StringConditional.Messagetype identifierspecifiedbytheclient whensendingthemessage.
JMSTimestamp
JMSType
properties
DocumentConditional.ADocumentcontaining optionalfieldsaddedtothemessageheader. IntegrationServermayaddthefollowingpropertiesto JMSmessagesitreceives. Key activation Description StringConditional.Aunique identifierassignedbythesending service.AJMStriggercanjoin togethermessageswiththesame activation. StringConditional.Auniversally uniqueidentifierforthemessage assignedbythesender. IntegrationServercanusetheuuid forexactlyonceprocessingorfor request/reply.
uuid
body
DocumentConditional.ADocumentcontainingthe JMSmessagebody.Amessagebodycanbeinoneof thefollowingformatssupportedbyIntegration Server: Key string bytes Description StringConditional.Messagebody intheformofaString. primitive typeConditionalMessage bodyintheformofaone dimensionalbytearray. Object.Conditional.Messagebody intheformofaSerializableJava object.
object
233
12 JMS Folder
data
DocumentConditional.Message bodyintheformofadocument (IDataobject). Note: Thismessageformatcan onlybeusedwhensendingaJMS messagefromoneIntegration Servertoanother.WhentheJMS messageissent,thesending IntegrationServerencodesthe IDataintoabytearray.Whenthe receivingIntegrationServer receivesthemessage,itdecodes thebytearrayintoIData.
message
ObjectConditional.Messagebody intheformofanactual javax.jms.Message.
Usage Notes Thepub.jms:replyservicecreatesaJMSmessage(javax.jms.Message)basedoninput providedtotheserviceortakesanexistingJMSmessageandsendsittotheJMS providerasareplytoarequestingclient. TheJMSReplyTofieldintherequestmessageissetbythesendingclientandindicates thedestinationtowhichthereplywillbesent. ThereplyingIntegrationServerautomaticallysetsthisvaluewhenitexecutesthe pub.jms:replyservice. Whenexecutingthepub.jms:replyservice,IntegrationServerautomaticallysetsthe valueoftheJMSCorrelationIDfieldintheJMSReplyMessage.IntegrationServeruses thevalueofeithertheuuidorJMSMessageIDfieldsintherequestingJMSmessageto correlatetherequestandtheresponse.Ifyouspecifytheuuidwhensendingthe request,thereplyingIntegrationServerwillusetheuuidastheJMSCorrelationIDof thereplymessage.Ifyoudonotspecifyauuid,thereplyingIntegrationServeruses theJMSMessageIDoftherequestmessageastheJMSCorrelationIDofthereply message. Whenreplyingtoamessagereceivedusingpub.jms:receive,youneedtospecifythe inputparametersconsumerandmessage. Ifatransactionhasnotyetbeenstarted,thetransactionmanagerstartsatransaction contextforanimplicittransactionwhenIntegrationServerexecutesapub.jms:reply servicethatusesatransactedJMSconnectionalias.AJMSconnectionaliasis consideredtobetransactedwhenithasatransactiontypeofXATRANSACTIONor LOCALTRANSACTION. Ifyouwantmorecontrolovertheactualjavax.jms.MessagethatIntegrationServer sendstotheJMSprovider,youcancreateaJavaservicethatcallsthe
234
12 JMS Folder
com.wm.app.b2b.server.jms.producer.ProducerFacadeclass,whichwillcreatea javax.jms.Message.See: com.wm.app.b2b.server.jms.producer.ProducerFacade.createBytesMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createMapMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createObjectMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createStreamMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createTextMessage(String) TheJavaservicecallingthisAPImustreturnanObjectoftypejavax.jms.Message, whichcanthenbemappedtotheJMSMessage/body/messageinputparameterofthe pub.jms:replyservice. Whencreatingthejavax.jms.Messagewiththe com.wm.app.b2b.server.jms.producer.ProducerFacade,youcanusethe javax.jms.Messagesettermethodstosetthevaluesofthemessageheadersand propertiesdirectly.Youcanalsosetthevalueofmessageheadersandproperties usingtheinputparametersofthepub.jms:reply servicethatyouusetosendthe message.Ifyousetthemessageheadersandpropertiesbothways,thevalues providedtothepub.jms:reply servicetakeprecedence. Software AGrecommendsthatyouuseapub.jms:replyservicetocreateandsendthe JMSmessage.Thismayprovidebetterperformanceonaverage.However,ifyou wanttosendaStreamMessageoraMapMessage,youneedtousetheappropriate com.wm.app.b2b.server.jms.producer.ProducerFacadeAPI. See Also pub.jms:createConsumer pub.jms:receive.
235
12 JMS Folder
pub.jms:send
WmPublic.SendsaJMSmessagetotheJMSprovider. Input Parameters connectionAliasName StringNameoftheJMSconnectionaliasthatyouwanttouseto sendthemessage. TheJMSconnectionaliasindicateshowIntegrationServer connectstotheJMSprovider.AJMSconnectionaliascan specifythatIntegrationServeruseaJNDIprovidertolookup administeredobjects(connectionfactoriesanddestinations) andthenusetheconnectionfactorytocreateaconnection. Alternatively,aJMSconnectionaliascanspecifythat IntegrationServerusesthenativewebMethodsAPItocreate theconnectiondirectlyonthewebMethodsJMSProvider. destinationName StringNameorlookupnameoftheDestinationtowhichyou wanttosendthemessage.Specifythelookupnameofthe DestinationobjectwhentheJMSconnectionaliasusesJNDIto retrieveadministeredobjects.Specifytheproviderspecific nameoftheDestinationwhentheJMSconnectionaliasuses thenativewebMethodsAPItoconnectdirectlytothe webMethodsJMSProvider. StringOptional.Typeofdestinationtowhichyouwanttosend themessage.Specifyoneofthefollowing: Select...
QUEUE TOPIC
destinationType
To... Default.Sendthemessagetoaparticularqueue. Sendthemessagetoatopic.
Note: YouneedtospecifyadestinationTypeonlyifyouspecified aconnectionAliasNamethatusesthenativewebMethodsAPI.
236
12 JMS Folder
JMSMessage
Document AdocumentrepresentingtheJMSmessageyouwant tosend. Key header Description DocumentOptional.Adocumentcontainingthe headeroftheJMSmessage. Key deliveryMode Description StringOptional.Specifiesthe messagedeliverymodeforthe message.Specifyoneofthe following: Select...
PERSISTENT
To... Default. Provideonce andonlyonce deliveryfor themessage. Themessage willnotbelost ifaJMS provider failureoccurs. Provideat mostonce deliveryfor themessage. Themessage hasno guaranteeof beingsavedif aJMS provider failureoccurs.
NON_PERSISTENT
priority
java.lang.IntegerOptional. Specifiesthemessagepriority. JMSdefinesprioritylevelsfrom 0to9,with0asthelowest priorityand9asthehighest. Thedefaultis4.
237
12 JMS Folder
timeToLive
java.lang.LongOptional.Lengthof time,inmilliseconds,thatthe JMSproviderretainsthe message.Thedefaultis0, meaningthatthemessagedoes notexpire. StringOptional.Messagetype identifierforthemessage.
JMSType properties
DocumentOptional.ADocumentcontaining optionalfieldsaddedtothemessageheader. IntegrationServeraddsthefollowingproperties toJMSmessagesitsends. Key activation Description StringOptional.Aunique identifierusedtogrouptogether messagesthatwillbereceivedby aJMStriggerwithajoin.AJMS triggercanjointogether messageswiththesame activation. StringOptional.Auniversally uniqueidentifierforthe message.IntegrationServercan usetheuuidforexactlyonce processingorforrequest/reply.
uuid
body
DocumentOptional.ADocumentcontainingthe JMSmessagebody.Amessagebodycanbeinone ofthefollowingformatssupportedbyIntegration Server: Key string bytes Description StringOptional.Messagebodyin theformofaString. primitive typeOptionalMessage bodyintheformofaone dimensionalbytearray. Object.Optional.Messagebody intheformofaSerializableJava object.
object
238
12 JMS Folder
data
DocumentOptional.Message bodyintheformofadocument (IDataobject). Note: Thismessageformatcan onlybeusedwhensendinga JMSmessagefromone IntegrationServertoanother. WhentheJMSmessageissent, thesendingIntegrationServer encodestheIDataintoabyte array.Whenthereceiving IntegrationServerreceivesthe message,itdecodesthebyte arrayintoIData.
message
ObjectOptional.Messagebodyin theformofanactual javax.jms.Message.
useCSQ
java.lang.BooleanOptional.FlagindicatingwhetherIntegration ServerplacessentmessagesintheclientsidequeueiftheJMS providerisnotavailableatthetimethemessagesaresent. Specify...

True
To... Default.Writemessagestotheclientsidequeueif theJMSproviderisnotavailableatthetimethis serviceexecutes.WhentheJMSproviderbecomes available,IntegrationServersendsmessagesfrom theclientsidequeuetotheJMSprovider. ThrowanISRuntimeExceptioniftheJMS providerisnotavailableatthetimethisservice executes.
False
239
12 JMS Folder
Output Parameters JMSMessage Document.ADocumentcontainingthemessagesenttotheJMS provider. Key header Description DocumentConditional.ADocumentcontainingthe headerfieldsforthesentmessage.TheJMSprovider populatesthesefieldsafterithassuccessfullyreceived themessagefromIntegrationServer. JMSCorrelationID StringConditional.Aunique identifierusedtolinkmessages together. java.lang.IntegerDeliverymodeused tosendthemessage.
PERSISTENTindicatesthattheJMS
JMSDeliveryMode
providerprovidesonceandonly oncedeliveryforthemessage.The messagewillnotbelostifaJMS providerfailureoccurs.

NON_PERSISTENTindicatesthatthe
JMSproviderprovidesatmostonce deliveryforthemessage.The messagehasnoguaranteeofbeing savedifaJMSproviderfailure occurs. Note: Whensendingamessage,this valueisobtainedfromthe JMSMessage/header/deliveryMode inputparameter. JMSDestination ObjectConditional.Destination (queueortopic)towhichthe messagewassent.
240
12 JMS Folder
JMSExpiration
java.lang.Long Conditional.Timeat whichthismessageexpires.Ifthe messageproducerdidnotspecifya timetolive,theJMSExpirationvalue iszero,indicatingthemessagedoes notexpire. Note: Whensendingamessage,this valueisobtainedfromthe JMSMessage/header/timeToLiveinput parameter.
JMSMessageID
StringConditional.Uniqueidentifier assignedtothismessagebytheJMS provider. java.lang.IntegerConditional.Defines themessagepriority.JMSdefines prioritylevelsfrom0to9,with0as thelowestpriorityand9asthe highest. Note: Whensendingamessage,this valueisobtainedfromthe JMSMessage/header/priorityinput parameter.
JMSPriority
JMSRedelivered
java.lang.BooleanConditional.Flag indicatingtheJMSprovider deliveredthismessagetotheJMS clientpreviously.

Trueindicatesthemessagemay
havebeendeliveredinthepast.
FalseindicatestheJMSprovider
hasnotdeliveredthismessage previously. JMSReplyTo ObjectConditional.Specifiesthe destinationtowhichresponseto thismessageshouldbesent. java.lang.LongTimeatwhichthe messagewasgiventotheJMS provider. StringConditional.Messagetype identifierspecifiedbytheclient whensendingthemessage.
JMSTimestamp
JMSType
241
12 JMS Folder
properties
DocumentConditional.ADocumentcontainingoptional fieldsaddedtothemessageheader.IntegrationServer addsthefollowingpropertiestoJMSmessagesitsends. Key activation Description StringConditional.Aunique identifierassignedbythesender.A JMStriggercanjointogether messageswiththesameactivation. StringConditional.Auniversally uniqueidentifierforthemessage assignedbythesender.Integration Servercanusetheuuidforexactly onceprocessingorforrequest/reply.
uuid
body
DocumentConditional.ADocumentcontainingtheJMS messagebody.Amessagebodycanbeinoneofthe followingformatssupportedbyIntegrationServer: Key string bytes Description StringConditional.Messagebodyin theformofaString. primitive typeConditionalMessage bodyintheformofaone dimensionalbytearray. Object.Conditional.Messagebody intheformofaSerializableJava object.
object
242
12 JMS Folder
data
DocumentConditional.Message bodyintheformofadocument (IDataobject). Note: Thismessageformatcanonly beusedwhensendingaJMS messagefromoneIntegration Servertoanother.WhentheJMS messageissent,thesending IntegrationServerencodesthe IDataintoabytearray.Whenthe receivingIntegrationServer receivesthemessage,itdecodesthe bytearrayintoIData.
message
ObjectConditional.Messagebodyin theformofanactual javax.jms.Message.
Usage Notes Thepub.jms:sendservicecreatesaJMSmessage(javax.jms.Message)basedoninput providedtotheserviceortakesanexistingJMSmessageandsendsittotheJMS provider. Ifatransactionhasnotyetbeenstarted,thetransactionmanagerstartsatransaction contextforanimplicittransactionwhenIntegrationServerexecutesapub.jms:send servicethatusesatransactedJMSconnectionalias.AJMSconnectionaliasis consideredtobetransactedwhenithasatransactiontypeofXATRANSACTIONor LOCALTRANSACTION. YoucanaddpropertiestoaJMSmessagewhenbuildingaflowservicethatinvokes thisservice.InDeveloper,onthePipelinetab,addanewvariableto JMSMessage/properties. IftheJMSconnectionaliasspecifiedforconnectionAliasNameusesthenative webMethodsAPI,youneedtospecifydestinationNameanddestinationTypetoindicate wheretheJMSprovidershouldsendthemessage. IntegrationServercreatestheoutputparameterJMSMessagebecausesomeofthe headerfieldsinaJMSmessagearepopulatedbytheJMSproviderafterthemessageis sent.Forexample,theheaderfieldJMSMessageIDisnotintheJMSmessagesentby IntegrationServer,butJMSMessageIDisintheheaderaftertheJMSproviderreceives themessage. EachJMSconnectionaliashasitsownclientsidequeue.IntegrationServerplaces messagesintheclientsidequeueiftheJMSproviderisnotavailableatthetimethe pub.jms:receiveserviceexecutes.WhentheJMSproviderbecomesavailable,Integration ServersendsmessagesfromtheclientsidequeuetotheJMSprovider.
243
12 JMS Folder
TheJMSproviderpopulatestheheaderfieldsintheJMSMessageoutputparameter afteritsuccessfullyreceivesthesentmessagefromIntegrationServer.IftheJMS providerisnotavailableatthetimethepub.jms:sendexecutesanduseCSQissettotrue, theheaderfieldsintheoutputJMSMessagewillnotbepopulated.Insteadthesefields willbeblankorbesetto0(zero). Ifclientsidequeuingisnotused(useCSQissettoFalse),IntegrationServerthrows anISRuntimeExceptioniftheJMSproviderisnotavailablewhenthisservice executes.Makesuretocodeyourservicetohandlethissituation. Whensendingamessageaspartofatransaction(theJMSconnectionaliasspecified inconnectionAliasNamehasatransactiontypeofLOCAL_TRANSACTIONor XA_TRANSACTION),clientsidequeuingcannotbeused.Thatis,theuseCSQfield shouldbesettoFalse.IfuseCSQissettoTrue,IntegrationServerthrowsa JMSSubsystemExceptionwhenthepub.jms:sendserviceexecutes. Ifyoudonotspecifyadestinationforreplymessages,IntegrationServerusesa temporaryQueuetoreceivethereply.AtemporaryQueueisaqueueobjectcreatedfor thedurationofaparticularconnection.Itcanonlybeconsumedbytheconnection fromwhichitwascreated. Ifyouwantmorecontrolovertheactualjavax.jms.MessagethatIntegrationServer sendstotheJMSprovider,youcancreateaJavaservicethatcallsthe com.wm.app.b2b.server.jms.producer.ProducerFacadeclass,whichwillcreatea javax.jms.Message.See: com.wm.app.b2b.server.jms.producer.ProducerFacade.createBytesMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createMapMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createObjectMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createStreamMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createTextMessage(String) TheJavaservicecallingthisAPImustreturnanObjectoftypejavax.jms.Message, whichcanthenbemappedtotheJMSMessage/body/messageinputparameterofthe pub.jms:sendservice. Whencreatingthejavax.jms.Messagewiththe com.wm.app.b2b.server.jms.producer.ProducerFacade,youcanusethe javax.jms.Messagesettermethodstosetthevaluesofthemessageheadersand propertiesdirectly.Youcanalsosetthevalueofmessageheadersandproperties usingtheinputparametersofthepub.jms:send servicethatyouusetosendthe message.Ifyousetthemessageheadersandpropertiesbothways,thevalues providedtothepub.jms:send servicetakeprecedence. Software AGrecommendsthatyouuseapub.jms:sendservicetocreateandsendthe JMSmessage.Thismayprovidebetterperformanceonaverage.However,ifyou wanttosendaStreamMessageoraMapMessage,youneedtousetheappropriate com.wm.app.b2b.server.jms.producer.ProducerFacadeAPI.
244
12 JMS Folder
pub.jms:sendAndWait
WmPublic.SendsarequestintheformofaJMSmessagetotheJMSproviderand optionally,waitsforareply. Input Parameters connectionAliasName StringNameoftheJMSconnectionaliasthatyouwanttouse tosendthemessage. TheJMSconnectionaliasindicateshowIntegrationServer connectstotheJMSprovider.AJMSconnectionaliascan specifythatIntegrationServeruseaJNDIprovidertolook upadministeredobjects(connectionfactoriesand destinations)andthenusetheconnectionfactorytocreatea connection.Alternatively,aJMSconnectionaliascanspecify thatIntegrationServerusesthenativewebMethodsAPIto createtheconnectiondirectlyonthewebMethodsJMS Provider. destinationName StringNameorlookupnameoftheDestinationtowhichyou wanttosendthemessage.Specifythelookupnameofthe DestinationobjectwhentheJMSconnectionaliasusesJNDI toretrieveadministeredobjects.Specifytheprovider specificnameoftheDestinationwhentheJMSconnection aliasusesthenativewebMethodsAPItoconnectdirectlyto thewebMethodsJMSProvider. StringOptional.Typeofdestinationtowhichyouwantto sendthemessage.Specifyoneofthefollowing: Select...
QUEUE
destinationType
To... Default.Sendthemessagetoaparticular queue. Sendthemessagetoatopic.
TOPIC
Note: YouneedtospecifyadestinationTypeonlyifyou specifiedaconnectionAliasNamethatusesthenative webMethodsAPI.
245
12 JMS Folder
destinationNameReplyTo
StringOptional.NameorlookupnameoftheDestinationto whichyouwantthereplymessagesent.Specifythelookup nameoftheDestinationobjectwhentheJMSconnection aliasusesJNDItoretrieveadministeredobjects.Specifythe providerspecificnameoftheDestinationwhentheJMS connectionaliasusesthenativewebMethodsAPItoconnect directlytothewebMethodsJMSProvider. Ifyoudonotspecifyadestinationforreplymessages, IntegrationServerusesatemporaryQueuetoreceivethe reply.AtemporaryQueueisaqueueobjectcreatedforthe durationofaparticularconnection.Itcanonlybeconsumed bytheconnectionfromwhichitwascreated.
destinationTypeReplyTo
StringOptional.Typeofdestinationtowhichyouwantthe replytobesent.Specifyoneofthefollowing: Select...

QUEUE
To... Default.Sendthereplymessagetoaparticular queue. Sendthereplymessagetoaspecifictopic.
TOPIC
Note: YouneedtospecifyadestinationTypeReplyToonlyifyou specifiedaconnectionAliasNamethatusesthenative webMethodsAPIandyouspecifiedavaluefor destinationNameReplyTo. timeout java.lang.LongOptional.Timetowait(inmilliseconds)forthe responsetoarrive.Ifnovalueisspecified,theservicedoes notwaitatall. Thetimeoutvalueonlyappliesforasynchronous request/reply.Ifasyncissettofalse,IntegrationServer ignoresthetimeoutvalue.
246
12 JMS Folder
JMSMessage
Document AdocumentrepresentingtheJMSmessageyou wanttosend. Key header Description DocumentOptional.Adocumentcontainingthe headeroftheJMSmessage. Key deliveryMode Description StringOptional.Specifiesthe messagedeliverymodeforthe message.Specifyoneofthe following: Select...
PERSISTENT
To... Default. Provideonce andonly oncedelivery forthe message.The messagewill notbelostifa JMSprovider failureoccurs. Provideat mostonce deliveryfor themessage. Themessage hasno guaranteeof beingsavedif aJMS provider failureoccurs.
NON_PERSISTENT
priority
java.lang.IntegerOptional. Specifiesthemessagepriority. JMSdefinesprioritylevelsfrom 0to9,with0asthelowest priorityand9asthehighest. Thedefaultis4.
247
12 JMS Folder
timeToLive
java.lang.LongOptional.Length oftime,inmilliseconds,thatthe JMSproviderretainsthe message.Thedefaultis0, meaningthatthemessagedoes notexpire. StringOptional.Messagetype identifierforthemessage. IntegrationServerexpectsthe replymessagetobeofthistype.
JMSType
properties
DocumentOptional.ADocumentcontaining optionalfieldsaddedtothemessageheader. IntegrationServeraddsthefollowing propertiestoJMSmessagesitsends. Key activation Description StringOptional.Aunique identifierusedtogroup togethermessagesthatwillbe receivedbyaJMStriggerwitha join.AJMStriggercanjoin togethermessageswiththe sameactivation. StringOptional.Auniversally uniqueidentifierforthe message.IntegrationServercan usetheuuidforexactlyonce processingorforrequest/reply.
uuid
body
DocumentOptional.ADocumentcontainingthe JMSmessagebody.Amessagebodycanbein oneofthefollowingformatssupportedby IntegrationServer:. Key string bytes Description StringOptional.Messagebody intheformofaString. primitive typeOptional.Message bodyintheformofaone dimensionalbytearray. Object.Optional.Messagebody intheformofaSerializableJava object.
object
248
12 JMS Folder
data
DocumentOptional.Message bodyintheformofadocument (IDataobject). Note: Thismessageformatcan onlybeusedwhensendinga JMSmessagefromone IntegrationServertoanother. WhentheJMSmessageissent, thesendingIntegrationServer encodestheIDataintoabyte array.Whenthereceiving IntegrationServerreceivesthe message,itdecodesthebyte arrayintoIData.
message
ObjectOptional.Messagebody intheformofanactual javax.jms.Message.
async
java.lang.BooleanOptional.Flagspecifyingwhetherthisisan asynchronousorsynchronousrequest/reply. Specify...

True
To... Indicatethatthisisanasynchronous request/reply.Aftersendingthemessage, IntegrationServerexecutesthenextstepinthe flowserviceimmediately.TheIntegration Serverdoesnotwaitforareplybefore continuingserviceexecution. Note: Toretrievethereplytoanasynchronous send,invokethepub.jms:waitForReplyservice.
False
Default.Indicatethatthisisasynchronous request/reply.Aftersendingthemessage,the IntegrationServerwaitsforareplybefore executingthenextstepintheflowservice.
249
12 JMS Folder
useCSQ
java.lang.BooleanOptional.Flagindicatingwhether IntegrationServerplacessentmessagesintheclientside queueiftheJMSproviderisnotavailableatthetimethe messagesaresent. Specify...

True
To... Default.Writemessagestotheclientsidequeue iftheJMSproviderisnotavailableatthetime thisserviceexecutes.WhentheJMSprovider becomesavailable,IntegrationServersends messagesfromtheclientsidequeuetotheJMS provider. ThrowanISRuntimeExceptioniftheJMS providerisnotavailableatthetimethisservice executes.
False
Note: IntegrationServercanwritemessagestotheclientside queueonlyformessagessentaspartofanasynchronous request/reply.Thatis,ifasyncissettotrue(thedefault)and theJMSproviderisnotavailableatthetimethisservice executes,IntegrationServerplacesthemessageintheclient sidequeue. Output Parameters JMSMessage Document.ADocumentcontainingthemessagesenttotheJMS provider. Key header Description DocumentConditional.ADocumentcontainingthe headerfieldsforthesentmessage.TheJMSprovider populatesthesefieldsafterithassuccessfully receivedthemessagefromIntegrationServer. JMSCorrelationID StringConditional.Aunique identifierusedtolink messagestogether.
250
12 JMS Folder
JMSDeliveryMode
java.lang.IntegerDeliverymode usedtosendthemessage.
PERSISTENTindicatesthatthe
JMSproviderprovidesonce andonlyoncedeliveryfor themessage.Themessage willnotbelostifaJMS providerfailureoccurs.

NON_PERSISTENTindicatesthat theJMSproviderprovidesat mostoncedeliveryforthe message.Themessagehasno guaranteeofbeingsavedifa JMSproviderfailureoccurs.
Note: Whensendinga message,thisvalueis obtainedfromthe JMSMessage/header/deliveryMo deinputparameter. JMSDestination ObjectConditional. Destination(queueortopic) towhichthemessagewas sent. java.lang.Long Optional.Time atwhichthismessageexpires. Ifthemessageproducerdid notspecifyatimetolive,the JMSExpirationvalueiszero, indicatingthemessagedoes notexpire. Note: Whensendinga message,thisvalueis obtainedfromthe JMSMessage/header/timeToLive inputparameter. JMSMessageID StringConditional.Unique identifierassignedtothis messagebytheJMSprovider.
JMSExpiration
251
12 JMS Folder
JMSPriority
a.lang.IntegerOptional.Defines themessagepriority.JMS definesprioritylevelsfrom0 to9,with0asthelowest priorityand9asthehighest. Note: Whensendinga message,thisvalueis obtainedfromthe JMSMessage/header/priority inputparameter.
JMSRedelivered
java.lang.BooleanConditional. FlagindicatingtheJMS providerdeliveredthis messagetotheJMSclient previously.

Trueindicatesthemessage
mayhavebeendeliveredin thepast.
FalseindicatestheJMS
providerhasnotdelivered thismessagepreviously. JMSReplyTo ObjectConditional.Specifies thedestinationtowhichthe replytothismessageshould besent.The destinationNameReplyTovalue determinesthevalueof JMSReplyTo. java.lang.LongTimeatwhich themessagewasgiventothe JMSprovider. StringConditional.Message typeidentifierspecifiedby theclientwhensendingthe message.
JMSTimestamp
JMSType
252
12 JMS Folder
properties
DocumentConditional.ADocumentcontaining optionalfieldsaddedtothemessageheader. IntegrationServeraddsthefollowingpropertiesto JMSmessagesitsends. Key activation Description StringConditional.Aunique identifierassignedbythe sender.AJMStriggercanjoin togethermessageswiththe sameactivation. StringConditional.A universallyuniqueidentifier forthemessageassignedby thesender.IntegrationServer canusetheuuidforexactly onceprocessingorfor request/reply.
uuid
body
DocumentConditional.ADocumentcontainingthe JMSmessagebody.Amessagebodycanbeinoneof thefollowingformatssupportedbyIntegration Server. Key string bytes Description StringConditional.Message bodyintheformofaString. primitive typeConditional Messagebodyintheformofa onedimensionalbytearray. Object.Conditional.Message bodyintheformofa SerializableJavaobject.
object
253
12 JMS Folder
data
DocumentConditional. Messagebodyintheformofa document(IDataobject). Note: Thismessageformatcan onlybeusedwhensendinga JMSmessagefromone IntegrationServertoanother. WhentheJMSmessageis sent,thesendingIntegration ServerencodestheIDatainto abytearray.Whenthe receivingIntegrationServer receivesthemessage,it decodesthebytearrayinto IData.
message
ObjectConditional.Message bodyintheformofanactual javax.jms.Message.
JMSReplyMessage
Document Conditional.DocumentcontainingtheJMSmessage receivedasareply. Ifthisisasynchronousrequest/replyandIntegrationServerdoes notreceiveaareplybeforethespecifiedtimeoutvalueelapses,the JMSReplyMessageisnull. Ifthisisanasynchronousreply,theJMSReplyMessageisnull. Key header Description DocumentConditional.ADocumentcontainingthe headerfieldsforthereplymessage. Key JMSCorrelationID Description StringConditional.Aunique identifierusedtolinkthe replymessagewiththeinitial requestmessage. ThereplyingIntegration Serverautomaticallysetsthis valuewhenitexecutesthe pub.jms:replyservice.
254
12 JMS Folder
JMSDeliveryMode
java.lang.IntegerConditional. Deliverymodeusedtosend themessage.

PERSISTENTindicatesthatthe
JMSproviderprovidesonce andonlyoncedeliveryfor themessage.Themessage willnotbelostifaJMS providerfailureoccurs.

NON_PERSISTENTindicatesthat theJMSproviderprovidesat mostoncedeliveryforthe message.Themessagehasno guaranteeofbeingsavedifa JMSproviderfailureoccurs.
JMSDestination
ObjectConditional. Destination(queueortopic) towhichthemessagewas sent. java.lang.Long Conditional. Timeatwhichthismessage expires.Ifthemessage producerdidnotspecifya timetolive,the JMSExpirationvalueiszero, indicatingthemessagedoes notexpire. StringConditional.Unique identifierassignedtothis messagebytheJMSprovider. java.lang.IntegerConditional. Definesthemessagepriority. JMSdefinesprioritylevels from0to9,with0asthe lowestpriorityand9asthe highest.
JMSExpiration
JMSMessageID
JMSPriority
255
12 JMS Folder
JMSRedelivered
java.lang.BooleanConditional. FlagindicatingtheJMS providerdeliveredthis messagetotheJMSclient previously.

Trueindicatesthemessage
mayhavebeendeliveredin thepast.
providerhasnotdelivered thismessagepreviously. JMSReplyTo ObjectConditional.Specifies thedestinationtowhicha responsetothismessage shouldbesent. java.lang.LongConditional. Timeatwhichthemessage wasgiventotheJMS provider. StringConditional.Message typeidentifierspecifiedby theclientwhensendingthe message.
JMSTimestamp
JMSType
properties
DocumentConditional.ADocumentcontaining optionalfieldsaddedtothemessageheader. IntegrationServeraddsthefollowingproprietiesto JMSmessagesitreceives. Key JMSXDeliveryCount Description java.lang.IntegerConditional. Specifiesthenumberoftimes theJMSproviderdelivered themessage.MostJMS providerssetthisvalue. StringConditional.Aunique identifierassignedbythe sender.AJMStriggerusesthe activationvaluetodetermine whetheramessagesatisfiesa join.
activation
256
12 JMS Folder
uuid
StringConditional.A universallyuniqueidentifier forthemessageassignedby thesender.IntegrationServer canusetheuuidforexactly onceprocessingorfor request/reply.
body
DocumentConditional.ADocumentcontainingthe JMSmessagebody.Amessagebodycanbeinoneof thefollowingformatssupportedbyIntegration Server: Key string bytes Description StringConditional.Message bodyintheformofaString. primitive typeConditional Messagebodyintheformofa onedimensionalbytearray. Object.Conditional.Message bodyintheformofa SerializableJavaobject. DocumentConditional. Messagebodyintheformofa document(IDataobject). Note: Thismessageformatcan onlybeusedwhensendinga JMSmessagefromone IntegrationServertoanother. WhentheJMSmessageis sent,thesendingIntegration ServerencodestheIDatainto abytearray.Whenthe receivingIntegrationServer receivesthemessage,it decodesthebytearrayinto IData. message ObjectConditional.Message bodyintheformofanactual javax.jms.Message.
object
data
257
12 JMS Folder
Usage Notes Thepub.jms:sendAndWaitservicecreatesaJMSmessage(javax.jms.Message)basedon inputprovidedtotheserviceortakesanexistingJMSmessage,sendsittotheJMS providerandoptionally,waitsforareply. Ifatransactionhasnotbeenstarted,thetransactionmanagerstartsatransaction contextforanimplicittransactionwhenIntegrationServerexecutesa pub.jms:sendAndWaitservicethatusesatransactedJMSconnectionalias.AJMS connectionaliasisconsideredtobetransactedwhenithasatransactiontypeofXA TRANSACTIONorLOCALTRANSACTION. YoucanaddpropertiestoaJMSmessagewhenbuildingaflowservicethatinvokes thisservice.InDeveloper,onthePipelinetab,addanewvariableto JMSMessage/properties. IftheJMSconnectionaliasspecifiedforconnectionAliasNameusesthenative webMethodsAPI,youneedtospecifydestinationNameanddestinationTypetoindicate wheretheJMSprovidershouldsendthemessage. YouneedtospecifyadestinationTypeReplyToonlyifyouspecifieda connectionAliasNamethatusesthenativewebMethodsAPIandyouspecifiedavalue fordestinationNameReplyTo. IntegrationServercreatestheoutputparameterJMSMessagebecausesomeofthe headerfieldsinaJMSmessagearepopulatedbytheJMSproviderafterthemessageis sent.Forexample,theheaderfieldJMSMessageIDisnotintheJMSmessagesentby IntegrationServer,butJMSMessageIDisintheheaderaftertheJMSproviderreceives themessage. Youcanusethepub.jms:sendAndWaitservicetoinitiatearequest/reply.Thesending clientsendsarequestforinformationtoeitheratopicorqueue.Clientsthatsubscribe tothedestinationcomposeandsendareplydocumentthatcontainstheinformation requestedbythesender. Asinglerequestmightreceivemanyreplymessages.IntegrationServerthatsentthe requestusesonlythefirstreplydocumentitreceivesfromtheJMSprovider. IntegrationServerdiscardsallotherreplies.Firstisarbitrarilydefined.Thereisno guaranteeprovidedfortheorderinwhichtheJMSproviderprocessesincoming replies. Thepub.jms:sendAndWaitservicecanbeusefulinsituationswheremultiplesources containtheresponsedata.Forexample,supposethatanenterpriseusesone applicationformanagingcustomerdata,anotherforstoringmastercustomer records,andamainframesystemforsavingcustomerlists.Eachoftheseapplications couldanswerarequestforcustomerdata.Therequestingservicewillusethefirst replymessageitreceives.
258
12 JMS Folder
Thepub.jms:sendAndWaitservicecanissuearequest/replyinasynchronousor asynchronousmanner. Inasynchronousrequest/reply,theservicethatsendstherequeststopsexecuting whileitwaitsforareply.Whentheservicereceivesareplymessage,theservice resumesexecution.Ifthetimeoutelapsesbeforetheservicereceivesareply, IntegrationServerendstherequest,andtheservicereturnsanullmessagethat indicatesthattherequesttimedout.IntegrationServerthenexecutesthenextstep intheflowservice. Inanasynchronousrequest/reply,theservicethatsendstherequestcontinues executingthestepsintheserviceaftersendingthemessage.Toretrievethereply, therequestingflowservicemustinvokethepub.jms:waitForReplyservice.Ifthe timeoutelapsesbeforethepub.jms:waitForReplyservicereceivesareply,the pub.jms:waitForReplyservicereturnsanulldocumentindicatingthattherequest timedout. Aservicethatcontainsmultipleasynchronoussendandwaitinvocationsallowsthe servicetosendalltherequestsbeforecollectingthereplies.Thisapproachcanbe moreefficientthansendingarequest,waitingforareply,andthensendingthenext request. ThereplyingIntegrationServerusesthevalueoruuidorJMSMessageIDinthe requestingJMSmessagetocorrelatetherequestandtheresponse.Ifyouspecifythe uuidwhensendingtherequest,thereplyingIntegrationServerwillusetheuuidasthe JMSCorrelationIDofthereplymessage.Ifyoudonotspecifyauuid,thereplying IntegrationServerusestheJMSMessageIDsetbytheJMSproviderasthe JMSCorrelationIDofthereplymessage. Ifyoucreateaservicethatcontainsmultipleasynchronousrequests,makesureto linktheJMSMessagefield(uuidorJMSMessageID)whosevaluewillbeusedasthe replymessagesJMSCorrelationIDtoanotherfieldinthepipeline.Eachasynchronous requestproducesaJMSMessagedocumentinthepipeline.Ifyoudonotlinktheuuid orJMSMessageIDfieldfromtheJMSMessagedocumenttoanotherfield,thenext asynchronousrequest(thatis,thenextexecutionofthepub.jms:sendAndWaitservice), willoverwritethepreviousJMSMessagedocument.Whenyouinvokethe pub.jms:waitForReplyservice,thepipelinewillcontainonlytheinputneededtoretrieve thereplytothelastrequest.Thepipelinewillnotcontaintheinformationneededto retrieverepliestothepreviousrequests.(Thatis,therewillbenothingtomaptothe correlationIDinputparameterofthepub.jms:waitForReplyservice.) IntegrationServercanwritemessagestotheclientsidequeueonlyformessagessent aspartofanasynchronousrequest/reply.Thatis,ifasyncissettotrue(thedefault) andtheJMSproviderisnotavailableatthetimethisserviceexecutes,Integration Serverplacesthemessageintheclientsidequeue.Clientsidequeueingcannotbe usedforasynchronousrequest/reply. TheJMSproviderpopulatestheheaderfieldsintheJMSMessageoutputparameter afteritsuccessfullyreceivesthesentmessagefromIntegrationServer.IftheJMS providerisnotavailableatthetimethepub.jms:sendexecutesanduseCSQissettotrue,
259
12 JMS Folder
theheaderfieldsintheoutputJMSMessagewillnotbepopulated.Insteadthesefields willbeblankorbesetto0(zero). Ifclientsidequeuingisnotused(useCSQissettoFalse),IntegrationServerthrows anISRuntimeExceptioniftheJMSproviderisnotavailablewhenthisservice executes.Makesuretocodeyourservicetohandlethissituation. Whensendingamessageaspartofatransaction(theJMSconnectionaliasspecified inconnectionAliasNamehasatransactiontypeofLOCAL_TRANSACTIONor XA_TRANSACTION),clientsidequeuingcannotbeused.Thatis,theuseCSQfield shouldbesettoFalse.IfuseCSQissettoTrue,IntegrationServerthrowsa JMSSubsystemExceptionwhenthepub.jms:sendserviceexecutes. Ifyoudonotspecifyadestinationforreplymessages,IntegrationServerusesa temporaryQueuetoreceivethereply.AtemporaryQueueisaqueueobjectcreatedfor thedurationofaparticularconnection.Itcanonlybeconsumedbytheconnection fromwhichitwascreated. Ifyouwantmorecontrolovertheactualjavax.jms.MessagethatIntegrationServer sendstotheJMSprovider,youcancreateaJavaservicethatcallsthe com.wm.app.b2b.server.jms.producer.ProducerFacadeclass,whichwillcreatea javax.jms.Message.See: com.wm.app.b2b.server.jms.producer.ProducerFacade.createBytesMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createMapMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createObjectMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createStreamMessage(String) com.wm.app.b2b.server.jms.producer.ProducerFacade.createTextMessage(String) TheJavaservicecallingthisAPImustreturnanObjectoftypejavax.jms.Message, whichcanthenbemappedtotheJMSMessage/body/messageinputparameterofthe pub.jms:sendAndWaitservice. Whencreatingthejavax.jms.Messagewiththe com.wm.app.b2b.server.jms.producer.ProducerFacade,youcanusethe javax.jms.Messagesettermethodstosetthevaluesofthemessageheadersand propertiesdirectly.Youcanalsosetthevalueofmessageheadersandproperties usingtheinputparametersofthepub.jms:sendAndWait servicethatyouusetosendthe message.Ifyousetthemessageheadersandpropertiesbothways,thevalues providedtothepub.jms:sendAndWait servicetakeprecedence. Software AGrecommendsthatyouuseapub.jms:sendAndWaitservicetocreateandsend theJMSmessage.Thismethodmayprovidebetterperformanceonaverage. However,ifyouwanttosendaStreamMessageoraMapMessage,youneedtouse theappropriatecom.wm.app.b2b.server.jms.producer.ProducerFacadeAPI. See Also pub.jms:reply pub.jms:waitForReply
260
12 JMS Folder
pub.jms:triggerSpec
WmPublic.SpecificationfortheinputsignatureofaJMStriggerthatprocessesone messageatatime. Input Parameters JMSMessage Output Parameters None. Usage Notes IfyouwanttouseaJMStriggertoretrieveandprocessmultiplemessagesinone batch,usepub.jms:batchTriggerSpectodeclaretheinputsandoutputsoftheJMStrigger service. See Also pub.jms:batchTriggerSpec pub.jms:JMSMessage DocumentAdocumentreference(IData)tothepub.jms:JMSMessage documenttype.
pub.jms:waitForReply
WmPublic.Retrievesthereplymessageforanasynchronousrequest. Input Parameters correlationID timeout StringUniqueidentifierusedtoassociatethereplymessagewiththe initialrequest. java.lang.LongOptional.Timetowait(inmilliseconds)forthereplyto arrive.Ifnovalueisspecified,theservicewaitsindefinitelyfora reply.
261
12 JMS Folder
Output Parameters JMSReplyMessage Document Conditional.DocumentcontainingtheJMSmessage receivedasareply. Ifthisisanasynchronousrequest/replyandIntegrationServer doesnotreceiveaareplybeforethespecifiedtimeoutvalue elapses,theJMSReplyMessageisnull. Key header Description DocumentConditional.ADocumentcontaining theheaderfieldsforthereplymessage. JMSCorrelationID StringConditional.A uniqueidentifierusedto linkthereplymessage withtheinitialrequest message. java.lang.Integer Conditional.Delivery modeusedtosendthe message.
PERSISTENTindicatesthat theJMSprovider providesonceandonly oncedeliveryforthe message.Themessage willnotbelostifaJMS providerfailureoccurs. NON_PERSISTENTindicates
JMSDeliveryMode
thattheJMSprovider providesatmostonce deliveryforthemessage. Themessagehasno guaranteeofbeingsaved ifaJMSproviderfailure occurs. JMSDestination ObjectConditional. Destination(queueor topic)towhichthe messagewassent.
262
12 JMS Folder
JMSExpiration
java.lang.Long Conditional.Timeat whichthismessage expires.Ifthemessage producerdidnotspecify atimetolive,the JMSExpirationvalueis zero,indicatingthe messagedoesnotexpire. StringConditional. Uniqueidentifier assignedtothismessage bytheJMSprovider. java.lang.Integer Conditional.Definesthe messagepriority.JMS definesprioritylevels from0to9,with0asthe lowestpriorityand9as thehighest. java.lang.Boolean Conditional.Flag indicatingtheJMS providerdeliveredthis messagetotheJMSclient previously.
Trueindicatesthe
JMSMessageID
JMSPriority
JMSRedelivered
messagemayhavebeen deliveredinthepast.
providerhasnot deliveredthismessage previously. JMSReplyTo ObjectConditional. Specifiesthedestination towhicharesponseto thismessageshouldbe sent. java.lang.Long Conditional.Timeat whichthemessagewas giventotheJMS provider.
JMSTimestamp
263
12 JMS Folder
JMSType
StringConditional. Messagetypeidentifier specifiedbytheclient whensendingthe message.
properties
DocumentConditional.AAdocument containingoptionalfieldsaddedtothemessage header.IntegrationServermayaddthe followingpropertiestoJMSmessagesitsends orreceives. Key JMSXDeliveryCount Description java.lang.Integer Conditional.Specifies thenumberoftimesthe JMSproviderdelivered themessagetothe requestingclient.Most JMSproviderssetthis value. StringConditional.A uniqueidentifier assignedbythesending service.AJMStrigger usestheactivationto determinewhethera messageispartofajoin. StringConditional.A universallyunique identifierforthemessage assignedbythesender. IntegrationServercan usetheuuidforexactly onceprocessingorfor request/reply.
activation
uuid
264
12 JMS Folder
body
DocumentConditional.ADocumentcontaining theJMSmessagebody.Amessagebodycanbe inoneofthefollowingformatssupportedby IntegrationServer. Key string Description StringConditional. Messagebodyinthe formofaString. primitive typeConditional Messagebodyinthe formofaone dimensionalbytearray. Object.Conditional. Messagebodyinthe formofaSerializable Javaobject. DocumentOptional. Messagebodyinthe formofadocument (IDataobject). Note: Thismessage formatcanonlybeused whensendingaJMS messagefromone IntegrationServerto another.WhentheJMS messageissent,the sendingIntegration ServerencodestheIData intoabytearray.When thereceivingIntegration Serverreceivesthe message,itdecodesthe bytearrayintoIData. message ObjectOptional.Message bodyintheformofan actual javax.jms.Message.
bytes
object
data
265
12 JMS Folder
Usage Notes IntegrationServerusesthevalueoftheuuidorJMSMessageIDfieldsintherequesting JMSmessagetocorrelatetheresponsetotherequest.Ifyouspecifytheuuidwhen sendingtherequest,thereplyingIntegrationServerwillusetheuuidasthe JMSCorrelationIDofthereplymessage(JMSReplyMessage).Ifyoudonotspecifya uuid,thereplyingIntegrationServerusestheJMSMessageIDsetbytheJMSprovider astheJMSCorrelationIDofthereplymessage(JMSReplyMessage). IfyousettheuuidintheJMSmessagerequest,youcanlinkthevalueoftheuuidfield fromtheJMSMessageproducedbythepub.jms:sendAndWaitservicetothecorrelationID inputfieldofthepub.jms:waitForReplyservice.Ifyoudidnotspecifyauuid,youcanlink theJMSMessageIDfieldfromtheJMSMessageproducedbythepub.jms:sendAndWaitto thecorrelationIDinputfield. ThetimeoutvalueofthesendingservicespecifieshowlongIntegrationServerwill keeptherequestopenwhilewaitingforareply.Ifareplyisnotavailableatthetime IntegrationServerexecutesthepub.jms:waitForReplyservice,IntegrationServer continuestowaitforthedocumentuntilthetimespecifiedinthetimeoutparameter elapses.IfIntegrationServerdoesnotreceiveareplybythetimethetimeoutinterval elapses,thepub.jms:waitForReplyservicereturnsanulldocument.Thisindicatesthatthe timeoutintervalexpired. See Also pub.jms:sendAndWait
pub.jms.wmjms:receiveStream
WmPublic.ReceivesalargemessagestreamfromaqueueortopiconthewebMethods JMSProvider. Input Parameters consumer ObjectAmessageconsumerobjectthattheserviceusestoreceivethe largemessagestream.Createthemessageconsumerobjectusingthe pub.jms:createConsumerservice. java.lang.LongOptional.Timetowait(inmilliseconds)forthefirst partofthemessagestream.Ifyoudonotspecifyatimeoutvalue,the consumerdoesnotwait.
timeout
Output Parameters stream ObjectAcom.webmethods.jms.impl.WmJMSInputStreamreceived bytheconsumer. Ifthetimeoutvalueelapsesbeforeamessageisreceived,streamwill benull.
266
12 JMS Folder
Usage Notes WhenusingwebMethodsJMSProvider,thewebMethodsmessagestreamingfeature allowsyoutostreamlargeamountsofdataoralargefilefromamessageproducerto amessageconsumer. Important! YoucanonlysendandreceivelargemessagesfromIntegrationServer whenworkingwiththewebMethodsJMSProvider.Formoreinformationabout howthewebMethodsmessagestreamingfeatureworksonthewebMethodsJMS Provider,seewebMethodsMessagingProgrammersGuide. Largemessagestreamscannotbesentorreceivedaspartofatransaction.IftheJMS connectionaliasusedbytheconsumerhasatransactiontypeof LOCAL_TRANSACTIONorXA_TRANSACTION,IntegrationServerthrowsan exception,specificallycom.wm.app.b2b.server.jms.JMSSubsystemException,whenit executesthepub.jms.wmjms:receiveStreamservice. Theconsumerthatyouusetoreceivethemessagedeterminesthedestinationfrom whichthisservicesreceivesmessagesandtheJMSconnectionaliasusedtoreceive themessages.Youcancreateamessageconsumerobjectusingthe pub.jms:createConsumerservice. Thetimeoutvaluespecifieshowlongthemessageconsumerwaitsfortheinitialpart ofthemessagestream.Ifamessageisnotreturnedwhenthetimeoutperiodelapses, thepub.jms.wmjms:receiveStreamreturnsanullvalue. Thereadtimeoutisthemaximumlengthoftimetheconsumerwaitsbetweenreceiving subsequentpiecesofthemessagestream.Afterthereadtimeoutelapses,the consumercallsInputStream.read()toreadthenextbyteofthestream.Ifthenextbyte ofthestreamisnotavailable,IntegrationServerthrowsaWmReadTimeoutexception. Thereadtimeoutonlyappliesaftertheconsumerreceivesthefirstpartofthe messagestream.Thewatt.server.jms.wmjms.lms.readTimeoutpropertydetermines thereadtimeoutvalue.Thedefaultis30000milliseconds. MakesuretocodeyourservicetohandleaWmReadTimeoutException.Whenan WmReadTimeoutExceptionoccurs,itsuggeststhatIntegrationServerdidnotreceive theentiremessagestream.Whenthisoccurs,youneedtoclosethestream,whichwill acknowledgeittothewebMethodsJMSProvider.Youcanclosethestreamfroma JavaservicebycallingInput.Stream.close.Youcanalsoclosethestreamusingthe pub.io:closeservice. IftheconnectionbetweentheIntegrationServerandwebMethodsJMSProviderfails duringexecutionofthepub.jms.wmjms:receiveStreamservice,IntegrationServerthrowsa WmConnectionException.Whenthisoccurs,IntegrationServerrollsthemessage backtothewebMethodsJMSProviderautomatically.Themessagecanbereceived whentheconnectiontothewebMethodsJMSProviderisreestablished. Youcancodeyourservicetoimplementrecoverabilitylogic.Thismeansthatthenext timethemessagestreamisreceived,theservicereprocessesthemessagestream fromthepointatwhichprocessingstopped.Toresumeprocessingfromthecorrect
267
12 JMS Folder
point,theserviceneedstokeeptrackofthemessageIDandbyteposition.Formore details,com.webmethods.jms.impl.WmJMSInputStream. Afterthepub.jms.wmjms:receiveStreamreceivesandprocessesthelastpartofthemessage stream,youneedtoclosethestream.InputStream.read()returns1whentheendof thestreamisreached.YoucanclosethestreamfromaJavaservicebycalling Input.Stream.close.Youcanalsoclosethestreamusingthepub.io:closeservice.Closing thestreamexplicitlyacknowledgesthemessagetotheprovider. TheconsumerusedtoreceivelargemessagestreamsfromthewebMethodsJMS ProvidercanspecifyanacknowledgementModeofAUTO_ACKNOWLEDGEor CLIENT_ACKNOWLEDGE.webMethodsJMSProviderdoesnotpermittheuseofthe acknowledgementModeisDUPS_OK_ACKNOWLEDGEforthe webMethodsmessage streamingfeature. YoumightwanttousetheschedulercapabilitieswithinIntegrationServerto scheduleaservicethatreceivesandthenprocesslargemessagesfromwebMethods JMSProvider.Formoreinformationaboutschedulingservices,seethewebMethods IntegrationServerAdministratorsGuide. See Also pub.io:close pub.jms:createConsumer pub.jms.wmjms:sendStream
pub.jms.wmjms:sendStream
WmPublic.SendsalargemessagestreamtothewebMethodsJMSProvider. Input Parameters connectionAliasName destinationName StringNameoftheJMSconnectionaliasthatyouwanttouseto sendthemessage. StringNameorlookupnameoftheDestinationtowhichyou wanttosendthemessage.Specifythelookupnameofthe DestinationobjectwhentheJMSconnectionaliasusesJNDIto retrieveadministeredobjects.Specifytheproviderspecific nameoftheDestinationwhentheJMSconnectionaliasuses thenativewebMethodsAPItoconnectdirectlytothe webMethodsJMSProvider.
268
12 JMS Folder
destinationType
StringOptional.Typeofdestinationtowhichyouwanttosend themessage.Specifyoneofthefollowing: Select...

QUEUE
To... Default.Sendthemessagetoaparticular receiver/queue.S. Sendthemessagetoatopic.
TOPIC
Note: YouneedtospecifyadestinationTypeonlyifyouspecified aconnectionAliasNamethatusesthenativewebMethodsAPI. stream Output Parameters None. Usage Notes WhenusingthewebMethodsJMSProvider,thewebMethodsmessagestreaming featureallowsyoutostreamlargeamountsofdataoralargefilefromamessage producertoamessageconsumer.Youcanonlysendandreceivelargemessagesfrom IntegrationServerwhenworkingwiththewebMethodsJMSProvider.Formore informationabouthowthewebMethodsmessagestreamingfeatureworksonthe webMethodsJMSProvider,seewebMethodsMessagingProgrammersGuide. Largemessagestreamscannotbesentorreceivedaspartofatransaction.If connectionAliasNamespecifiesaJMSconnectionaliaswithatransactiontypeof LOCAL_TRANSACTIONorXA_TRANSACTION,IntegrationServerthrowsthe exceptioncom.wm.app.b2b.server.jms.JMSSubsystemExceptionwhenitexecutesthe pub.jms.wmjms:sendStreamservice. IftheconnectionbetweenIntegrationServerandthewebMethodsJMSProviderfails beforethepub.jms.wmjms:sendStreamsendstheentiremessagestream,youneedtore sendtheentirestreamwhentheconnectionisreestablished. See Also pub.jms.wmjms:receiveStream ObjectAstreamforthemessageyouwanttosendtothe webMethodsJMSProvider.
269
12 JMS Folder
270
13
LDAP Folder
YouusetheelementsintheldapfoldertoaccessandupdateinformationonanLDAP directoryserver. Bydefault,theseservicesreturntheLDAPattributeobjectGUIinaformthatisnot humanreadable.Toreceivetheattributeinhumanreadableform,youmustsetthevalue ofthejavasystemenvironmentvariablejava.naming.ldap.attributes.binaryto objectGUID.Thispropertyisspecifiedonthewatt.config.systemPropertiespropertyin theIntegrationServerconfigurationfile.Ifthewatt.config.systemPropertiesproperty alreadyexistsintheserverconfigurationfile,besuretouseacommatoappendthe java.naming.ldap.attributes.binarypropertytotheendoftheserverconfiguration property,asshownbelow:
watt.config.systemProperties=mail.imap.partialfetch=true, java.naming.ldap.attributes.binary=objectGUID
SeethewebMethodsIntegrationServerAdministratorsGuideforinstructionsonupdating theserverconfigurationfile. Important! Theservicesinthisfolderhavebeendeprecated.Toaccessandupdate informationonanLDAPdirectoryserver,usetheservicesintheclient.ldapfolder instead.
271
13 LDAP Folder

Thefollowingelementsareavailableinthisfolder: Element pub.ldap:bind pub.ldap:connect pub.ldap:delete pub.ldap:disconnect pub.ldap:getAttributeDef pub.ldap:getClassDef pub.ldap:list pub.ldap:lookup pub.ldap:search pub.ldap:update Package and Description WmPublic.AddsanentryintotheLDAPserver. WmPublic.ConnectstoanLDAPserver. WmPublic.DeletesanentryfromtheLDAPserver. WmPublic.ClosesaconnectiontoanLDAPserver. WmPublic.Getsthedefinitionofanattributeinthedirectory serversschema. WmPublic.Getsthedefinitionofanobjectclassinthe directoryserversschema. WmPublic.Liststhebindingswithinaparticulardirectory context. WmPublic.Looksupasingleentryinthedirectoryserver. WmPublic.Searchesthedirectoryforentriesmatchingasetof criteria. WmPublic.ModifiesattributesofanentryintheLDAP directory.
pub.ldap:bind
WmPublic.AddsanentryintotheLDAPserver. Input Parameters ldapTargetName StringNameoftheentrythatyouwanttoadd.Forexample,to addauserentryforJoeKrebbsintheou=Peoplecontext,specify cn=Joe Krebbs,ou=PeopleforldapTargetName. ObjectOptional.JavaObjectthatyouwanttostoreintothis entry.SomeLDAPserversrestrictthekindsofobjectsyoucan store(somedonotevensupportstorageofJavaobjects). Typically,theobjectsmustimplementthejava.io.Serializable interface.ThedefaultvalueforldapTargetObjectisnull.
ldapTargetObject
272
13 LDAP Folder
ldapTargetAttributes
DocumentOptional.Attributestoassigntothenewentry.The key/valuepairsthatyouwillneedtosupplyin ldapTargetAttributeswillvarydependingonyourLDAPserver. Mostserverswillrequireanobjectclassattribute,butother attributesareusuallysitespecific.Refertotheschemaofyour servertodeterminewhichattributesitrequires.Thefollowing showsinputsyoumightusetoaddtheuserJoeKrebbs: Key objectclass cn sn uid mail Value
organizationalPerson Joe Krebbs jkrebbs jkrebbs@mycompany.com
ldapConnectionKey Output Parameters None. Usage Notes
StringKeyfortheconnectiontothedirectoryserver;thisisthe keyreturnedbypub.ldap:connect.
YoumusthavetheappropriatepermissionstoaddentriesintoanLDAPdirectory. Formostsimpleinsertions,youshouldnotneedtosupplyaJavaobjectvalueforthe ldapTargetObjectinputparameter.
pub.ldap:connect
WmPublic.ConnectstoanLDAPserver. Input Parameters ldapUrl ldapUser ldapPass Output Parameters ldapConnectionKey StringKeyfortheconnectiontothedirectoryserver. StringURLofthedirectoryservertoconnectwith.Forexample:
ldap://bigfoot.com
StringOptional.Usernametousetoconnecttothedirectory server. StringOptional.Passwordtousetoconnecttothedirectoryserver.
273
13 LDAP Folder
Usage Notes Theconnectionkeyreturnedbythisservicecanbeusedtoinvoketherestofthe pub.ldapservices(includingpub.ldap:disconnect).Theconnectiontothedirectoryserver remainsopenuntiltheservershutsdownoruntiltheconnectionisdisconnected. Toconnecttoasubdirectory,specifytheURLofthesubtreeforldapUrl.Forexample, ifyourdirectorystartsatldap://mydir.comandyouonlywanttooperateonthe subtreerootedatou=People,specify ldap://mydir.com/ou=PeopleforldapUrl.
pub.ldap:delete
WmPublic.DeletesanentryfromtheLDAPserver. Input Parameters ldapLookupName StringNameoftheentrythatyouwanttodelete.Forexample,to deleteJoeKrebbsfromtheou=Peoplecontext,specifycn=Joe Krebbs,ou=PeopleforldapLookupName. StringKeyfortheconnectiontothedirectoryserver;thisisthekey returnedfromtheexecutionofpub.ldap:connect.
ldapConnectionKey Output Parameters None. Usage Notes
YoumusthavetheappropriatepermissionstodeleteentriesinanLDAPdirectory.
pub.ldap:disconnect
WmPublic.ClosesaconnectiontoanLDAPserver. Input Parameters ldapConnectionKey Output Parameters None. Usage Notes UsethisservicetodisconnectfromanLDAPserverwhenyouaredoneusingthe connection. StringKeyfortheconnectiontothedirectoryserver;thisisthekey returnedfromtheexecutionofpub.ldap:connect.
274
13 LDAP Folder
pub.ldap:getAttributeDef
WmPublic.Getsthedefinitionofanattributeinthedirectoryserversschema. Input Parameters ldapAttributeName StringNameoftheattributeforwhichyouwanttogetthe definition.Forexample,togetthedefinitionofthemail attributeonthedirectoryserver,specifymailfor ldapAttributeName. StringKeyfortheconnectiontothedirectoryserver;thisisthekey returnedfromtheexecutionofpub.ldap:connect.
ldapConnectionKey Output Parameters ldapAttributeDef
DocumentDefinitionoftheattributespecifiedinldapAttributeName. Thisdocumentwillcontainthefollowinginformation: Key NAME NUMERICOID SYNTAX DESC Description StringNameoftheobjectclass. StringNumericOIDoftheobjectclass. StringNumericOIDofthesyntaxforthe attribute. StringDescriptionofthisobjectclass.
Forexample,thefollowingshowswhatthereturnedoutputmight looklikeforanattributenamedmail: Key NAME NUMERICOID SYNTAX DESC Usage Notes ThisservicehasbeentestedfortheNetscapeDirectoryservers.Ifyouuseadifferent LDAPdirectoryserver,testthisservicetoensureitworksforyourserver. Value
mail 2.16.840.1.113730.3.2.2 1.3.6.1.4.1.1466.115.121.1.15 Standard Attribute
275
13 LDAP Folder
pub.ldap:getClassDef
WmPublic.Getsthedefinitionofanobjectclassinthedirectoryserversschema. Input Parameters ldapObjectClass StringNameoftheobjectclassforwhichyouwanttoretrievethe definition.Forexample,togetthedefinitionofthe organizationalPersonclass,specifyorganizationalPerson for ldapObjectClass. StringKeyfortheconnectiontothedirectoryserver;thisisthekey returnedbypub.ldap:connect.
ldapConnectionKey Output Parameters ldapObjectClassDef
DocumentDefinitionoftheobjectclassspecifiedin ldapObjectClass.Thisdocumentwillcontainthefollowing information: Key NAME NUMERICOID MAY MUST DESC SUP Description StringNameoftheobjectclass. StringNumericOIDoftheobjectclass. String List Namesofoptionalattributes. String ListNamesofrequiredattributes. StringDescriptionofthisobjectclass. StringSuperclassofthisobjectclass.
Forexample,thefollowingshowswhatthereturnedoutput mightlooklikeforaclassnamedinetOrgPerson: Key NAME NUMERICOID MAY Value

inetOrgPerson 2.16.840.1.113730.3.2.2 aci description ssealso etc. objectclass sn cn Standard ObjectClass organizationalPerson
MUST
DESC SUP
276
13 LDAP Folder
Usage Notes ThisservicehasbeentestedfortheNetscapeDirectoryservers.Ifyouuseadifferent LDAPserver,testthisservicetoensureitworksforyourserver.
pub.ldap:list
WmPublic.Liststhebindingswithinaparticulardirectorycontext. Input Parameters ldapConnectionKey ldapListRoot StringKeyfortheconnectiontothedirectoryserver;thisisthe keyreturnedfromtheexecutionofpub.ldap:connect. StringOptional.Relativenameofthecontexttolist.Ifyoudo notspecifyavalueforldapListRoot,thedefaultis,which indicatestherootcontextforthedirectoryserver. StringOptional.Flagthatspecifieswhetheryouwantthe directorytoreturnobjectsfromthebindingsorjustthe attributes.Forexample,ifyourdirectorycontainspersisted Javaobjects,youwouldsetthisattributetotruetohavethose objectsreturned. Set to...
true false
ldapReturnObjects
To... Returnobjectsfromthebindings. Default.Returnonlyattributes.
ldapReturnAttributes
StringOptional.Commaseparatedlistofattributenamesto returnforeachofthelistedbindings.Forexample,toreturn onlythemailanduidattributes,youwouldsetthis parametertomail,uid. IfyoudonotspecifyldapReturnAttributes,allattributesare returned.
Output Parameters ldapListing Document ListConditional.Objectsboundwithinthespecified directorycontext.Thelistwillcontainonedocumentforeach object.Eachdocumentwillcontainthefollowinginformation: Key $name $class Description StringFullyqualifiednameofthebinding. StringConditional.Javaclassofthereturned object.Thiskeyispresentifyouset ldapReturnObjectstotrue.
277
13 LDAP Folder
$object
ObjectConditional.Objectboundtothisnamein thedirectory.Thiskeyispresentifyouset ldapReturnObjectstotrue.
ldapListingcontainsonesetofkeysforeachreturnedattribute. Usage Notes SupposethedirectoryserverrunningonmyCompany.comcontainsanou=Users context,whichcontainsanentry(binding)foreachuserinthedirectoryserver.Tolist theuserIDandemailaddressofeachuser,specifythefollowinginputparametersfor thepub.ldap:listservice: Key ldapListRoot ldapReturnObjects ldapReturnAttributes Value
ou=Users false uid,mail
Theresultingdocumentlistmightlooklikethis(perhapswithmoreentries): Key $name uid mail $name uid mail $name uid mail Value
cn=Arthur Milberg, ou=People amilberg amilberg@mycompany.com n=Dorothy Hadden, ou=People dhadden dhadden@mycompany.com cn=Scott Treezak, ou=People streezak streezak@mycompany.com
pub.ldap:lookup
WmPublic.Looksupasingleentryinthedirectoryserver. Input Parameters ldapConnectionKey ldapLookupName StringKeyfortheconnectiontothedirectoryserver;thisisthe keyreturnedfromtheexecutionofpub.ldap:connect. StringRelativenameofthecontexttolookup(forexample,
ou=People, cn=Arthur Milberg).
278
13 LDAP Folder
ldapReturnObject
StringOptional.Flagthatspecifieswhetheryouwantthe directorytoreturnobjectsfromthebindingsorjustthe attributes.Forexample,ifyourdirectorycontainspersisted Javaobjects,youwouldsetthisattributetotruetohavean objectreturned. Set to...

true false
To... Returnobjects. Default.Returnonlyattributes.
StringOptional.Commaseparatedlistofattributenamesto returnforeachofthelistedbindings.Forexample,toreturn onlythemailanduidattributes,setthisparameterto mail,uid. IfyoudonotspecifyavalueforldapReturnAttributes,all attributesarereturned.
Output Parameters ldapObject ObjectConditional.Theobjectboundtothegivennameinthe directory.ThisparameterispresentifyousetldapReturnObject totrue. DocumentAttributesassociatedwiththegivennameinthe directory.Thedocumentwillcontainonekeyforeach attributerequestedinldapReturnAttributes.
ldapAttributes
Usage Notes Toreducenetworktraffic,itisrecommendedthatyousettheldapReturnAttributes parametertoreturnalimitedsetofattributes.Trytoavoidrequestingallattributes.
279
13 LDAP Folder
pub.ldap:search
WmPublic.Searchesthedirectoryforentriesmatchingasetofcriteria. Input Parameters ldapConnectionKey ldapSearchFilter StringKeyfortheconnectiontothedirectoryserver;thisisthe keyreturnedfromtheexecutionofpub.ldap:connect. StringFilterdescribingwhichentriestoreturn.Forexample,to retrieveallentrieswiththeobjectClassgroupOfNamesand thecnofEngineers,youmightuse:
(&(objectclass=groupOfNames)(cn=Engineers))
FormoreinformationaboutLDAPsearchfilters,consultyour directoryserverdocumentationorlookforRFC1558. ldapSearchRoot StringOptional.Nameofthecontextinwhichtostartthe search.Defaultistherootentry.Thesearchwillberecursive unlessyouspecifytheldapSearchOneLevelparameter(see below).Forexample,tosearchonlytheou=Engineers subcontext,youwouldsetthisparametertoou=Engineers. StringOptional.Flagspecifyingwhethertosearchonlythe currentnodeorthecurrentnodeandeverythingbelowit. Set to...
true false
ldapSearchOneLevel
To... Searchonlythecurrentnode. Default.Searchthecurrentnodeandeverything belowit.
ldapReturnObjects
StringOptional.Specifieswhetherthedirectoryserveristo returnanobjectforthematchingentriesorjustattributes.For example,ifyourdirectorycontainspersistedJavaobjects,you wouldsetthisattributetotruetoreceivetheactualobjects. Set to...

true false
To... Returnobjects. Default.Returnonlyattributes.
StringOptional.Commaseparatedlistofattributenamesto returnforeachofthereturnedentries.Forexample,toreturn onlythemailanduidattributes,setthisparametertomail, uid. IfyoudonotspecifyldapReturnAttributes,allattributesare returned.
280
13 LDAP Folder
Output Parameters ldapSearchResults Document ListConditional.Objectsmatchingthesearchfilter.The listwillcontainonedocumentforeachobject.Eachdocument willcontainthefollowinginformation: Key $name $object Description StringFullyqualifiednameofthebinding. byte[ ]Conditional.Objectboundtothisnameon thedirectoryserver(returnedonlyifyouspecified trueforldapReturnObjects).
ldapSearchResultscontainsonesetofkeysforeachreturned attribute. Usage Notes Toreducenetworktraffic,speedupsearches,andavoidreturningunnecessarydata, bespecificwhenyoudefinesearchcriteria.Alsokeepinmindthatdifferentservers respondtosearchfiltersindifferentwaysbasedontheirschema.Forinstance,the (uid=a*)filtermightberejectedonaserverthatdoesnotallowsubstringsearcheson theuidattribute.
pub.ldap:update
WmPublic.ModifiesattributesofanentryintheLDAPdirectory. Input Parameters ldapLookupName StringNameoftheentrythatyouwanttomodify.Forexample, tomodifytheentryforJoeKrebbsintheou=Peoplecontext, specifycn=Joe Krebbs, ou=PeopleforldapLookupName. StringKeyfortheconnectionontheIntegrationServer;thisisthe keyreturnedfromtheexecutionofpub.ldap:connect. Document ListThechangesthatyouwanttomake.Foreach change,provideadocument(IDataobject)containingthe followinginformation: Key $name $modtype $value Description StringNameoftheattributetomodify. StringOptional.Actiontotake.Specifyremove,
replace,oradd.Thedefaultisadd.
ldapConnectionKey ldapAttributeMods
StringOptional.Newvaluetoassign,ifyouare addingorreplacingtheattribute.
281
13 LDAP Folder
Forexample,thefollowingshowsthevaluesyouwoulduseto change(replace)JoeKrebbsemailaddress: Key $name $modtype $value Output Parameters None. Usage Notes YoumusthavetheappropriatepermissionstomodifyentriesinanLDAPdirectory. Youcannotusethisservicetochangethevalueofanentryitself(thatis,ifyouhave boundJavaobjectsinyourdirectory,youmustdeletethemandrebindthenametoa differentJavaobject). Value
mail replace joe_krebbs@mycompany.com
282
14
List Folder
Youusetheelementsinthelistfoldertoretrieve,replace,oraddelementsinanObject List,DocumentList,orStringList.YoualsouselistservicestoconvertStringListsto DocumentLists.
283
14 List Folder

Thefollowingelementsareavailableinthisfolder: Element pub.list:appendToDocumentList pub.list:appendToStringList pub.list:sizeOfList pub.list:stringListToDocumentList Package and Description WmPublic.Addsdocumentstoadocumentlist. WmPublic.AddsStringstoaStringlist. WmPublic.Returnsthenumberofelementsinalist. WmPublic.ConvertsaStringlisttoadocumentlist.
pub.list:appendToDocumentList
WmPublic.Addsdocumentstoadocumentlist. Input Parameters toList fromList fromItem Document ListOptional.Listtowhichyouwanttoappend documents.IfyoudonotspecifytoList,theservicecreatesanewlist. Document ListOptional.Documentsyouwanttoappendtotheendof toList. DocumentOptional.Documentyouwanttoappendtotheendof toList.IfyouspecifybothfromListandfromItem,theserviceaddsthe documentspecifiedinfromItemafterthedocumentsinfromList.
Output Parameters toList Usage Notes ThedocumentscontainedinfromListandfromItemarenotactuallyappendedas entriestotoList.Instead,referencestothedocumentsinfromListandfromItemare appendedasentriestotoList.Consequently,anychangesmadetothedocumentsin fromListandfromItemalsoaffecttheresultingtoList. Document ListThetoListdocumentlistwiththedocumentsinfromList andfromItemappendedtoit.
284
14 List Folder
pub.list:appendToStringList
WmPublic.AddsStringstoaStringlist. Input Parameters toList String ListOptional.ListtowhichyouwanttoappendStrings.Ifthe valueoftoListisnull,anullpointerexceptionerroristhrown.Ifyou donotspecifytoList,theservicecreatesanewlist. String ListOptional.ListofStringstoaddtotoList.Stringsareadded aftertheentriesoftoList. StringOptional.StringyouwanttoappendtotheendoftoList.Ifyou specifybothfromListandfromItem,theserviceaddstheString specifiedinfromItemaftertheStringsspecifiedinfromList.
fromList fromItem
Output Parameters toList Usage Notes TheStringscontainedinfromListandfromItemarenotactuallyappendedasentriesto toList.Instead,referencestotheStringsinfromListandfromItemareappendedas entriestotoList.Consequently,anychangesmadetotheStringsinfromListand fromItemalsoaffecttheresultingtoList. String ListThetoListStringlistwiththeStringsfromfromListand fromItemappendedtoit.
pub.list:sizeOfList
WmPublic.Returnsthenumberofelementsinalist. Input Parameters fromList Document List,String List,orObject ListOptional.Listwhosesizeyou wanttodiscover.IffromListisnotspecified,theservicereturnsasize of0.
Output Parameters size fromList StringNumberofentriesinfromList. Document List,String ListorObject ListOriginallist.
285
14 List Folder
Usage Notes Forexample,iffromListconsistsof: fromList[0]=a fromList[1]=b fromList[2]=c Theresultwouldbe: size=3
pub.list:stringListToDocumentList
WmPublic.ConvertsaStringlisttoadocumentlist. Input Parameters fromList String ListOptional.ListofStrings(aString[])thatyouwantto converttoalistofdocuments(anIData[]).IffromListisnotspecified, theservicereturnsazerolengtharrayfortoList. StringOptional.Keynametouseinthegenerateddocumentlist.
key
Output Parameters toList Usage Notes CreatesadocumentlistcontainingonedocumentforeachelementinthefromList. EachdocumentwillcontainasingleStringelementnamedkey. Forexample,iffromListconsistsof: fromList[0]=a fromList[1]=b fromList[2]=c key=myKey Theresultwouldbe: Document ListResultingdocumentlist.
286
15
Math Folder
Youusetheelementsinthemathfoldertoadd,subtract,multiply,ordividestringbased numericvalues. Note: ServicesthatoperateonintegervaluesuseJavaslongdatatype(64bit,twos complement).ServicesthatoperateonfloatvaluesuseJavasdoubledatatype(64bit IEEE754).Ifextremelyprecisecalculationsarecriticaltoyourapplication,youshould writeyourownJavaservicestoperformmathfunctions.
287
15 Math Folder

Thefollowingelementsareavailableinthisfolder: Element pub.math:addFloatList pub.math:addFloats pub.math:addIntList pub.math:addInts pub.math:addObjects pub.math:divideFloats Package and Description WmPublic.Addsalistoffloatingpointnumbers (representedinaStringlist)andreturnsthesum. WmPublic.Addsonefloatingpointnumber(representedas aString)toanotherandreturnsthesum. WmPublic.Addsalistofintegers(representedinaString list)andreturnsthesum. WmPublic.Addsoneinteger(representedasaString)to anotherandreturnsthesum. WmPublic.Addsonejava.lang.Numberobjecttoanother andreturnsthesum. WmPublic.Dividesonefloatingpointnumber(represented asaString)byanother(num1/num2)andreturnsthe quotient. WmPublic.Dividesoneinteger(representedasaString)by another(num1/num2)andreturnsthequotient. WmPublic.Dividesonejava.lang.Numberobjectbyanother (num1/num2)andreturnsthequotient. WmPublic.Multipliesalistoffloatingpointnumbers (representedinaStringlist)andreturnstheproduct. WmPublic.Multiplesonefloatingpointnumber (representedasString)byanotherandreturnstheproduct. WmPublic.Multipliesalistofintegers(representedina Stringlist)andreturnstheproduct. WmPublic.Multipliesoneinteger(representedasaString) byanotherandreturnstheproduct. WmPublic.Multipliesonejava.lang.Numberobjectby anotherandreturnstheproduct. WmPublic.Returnsthenextpseudorandom,uniformly distributeddoublebetween0.0and1.0. WmPublic.Subtractsonefloatingpointnumber (representedasaString)fromanotherandreturnsthe difference.
pub.math:divideInts pub.math:divideObjects pub.math:multiplyFloatList pub.math:multiplyFloats pub.math:multiplyIntList pub.math:multiplyInts pub.math:multiplyObjects pub.math:randomDouble pub.math:subtractFloats
288
15 Math Folder
Element pub.math:subtractInts pub.math:subtractObjects
Package and Description WmPublic.Subtractsoneinteger(representedasaString) fromanotherandreturnsthedifference. WmPublic.Subtractsonejava.lang.Numberobjectfrom anotherandreturnsthedifference.
pub.math:addFloatList
WmPublic.Addsalistoffloatingpointnumbers(representedinaStringlist)andreturns thesum. Input Parameters numList String ListNumbers(floatingpointnumbersrepresentedasStrings)to add.
Output Parameters value StringSumofthenumbersinnumList.Ifasumcannotbeproduced, valuecontainsoneofthefollowing: Value

Infinity
Description Thecomputationproducesapositivevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesanegativevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesavaluethatunderflowsthe representablerangeofafloattype(forexample,addinga numbertoinfinity). Thecomputationproducesavaluethatcannotbe representedasanumber(forexample,anyoperation thatusesNaNasinput,suchas10.0+NaN=NaN).
-Infinity
0.0
NaN
Usage Notes MakesurethestringsthatarepassedtotheserviceinnumListareinalocaleneutral format(thatis,usingthepattern####.##).Passinglocallyformattedstringsmay resultinunexpectedresults.Forexample,callingpub.math:addFloatsinaGermanlocale withthearguments1,23and2,34willresultinthevalue357,not3.57or3,57.
289
15 Math Folder
pub.math:addFloats
WmPublic.Addsonefloatingpointnumber(representedasaString)toanotherand returnsthesum. Input Parameters num1 num2 StringNumbertoadd. StringNumbertoadd.
Output Parameters value StringSumofthenumbersinnum1andnum2.Ifasumcannotbe produced,valuecontainsoneofthefollowing: Value

Infinity
Description Thecomputationproducesapositivevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesanegativevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesavaluethatunderflowsthe representablerangeofafloattype(forexample, addinganumbertoinfinity). Thecomputationproducesavaluethatcannotbe representedasanumber(forexample,anyoperation thatusesNaNasinput,suchas10.0+NaN=NaN).
-Infinity
0.0
NaN
Usage Notes Makesurethestringsthatarepassedtotheserviceinnum1andnum2areinalocale neutralformat(thatis,usingthepattern####.##).Passinglocallyformattedstrings mayresultinunexpectedresults.Forexample,callingpub.math:addFloatsinaGerman localewiththearguments1,23and2,34willresultinthevalue357,not3.57or3,57.
pub.math:addIntList
WmPublic.Addsalistofintegers(representedinaStringlist)andreturnsthesum. Input Parameters numList String ListNumbers(integersrepresentedasStrings)toadd.
Output Parameters value StringSumofthenumbersinnumList.
290
15 Math Folder
pub.math:addInts
WmPublic.Addsoneinteger(representedasaString)toanotherandreturnsthesum. Input Parameters num1 num2 StringNumber(integerrepresentedasaString)toadd. StringNumber(integerrepresentedasaString)toadd.
Output Parameters value Usage Notes Makesuretheresultofyourcalculationislessthan64bitsinwidth(themaximum widthforthelongdatatype).Iftheresultexceedsthislimit,itwillgenerateadata overflow. Makesurethestringsthatarepassedtotheserviceinnum1andnum2areinalocale neutralformat(thatis,usingthepattern####.##).Passinglocallyformattedstrings mayresultinunexpectedresults.Forexample,callingpub.math:addFloatsinaGerman localewiththearguments1,23and2,34willresultinthevalue357,not3.57or3,57. StringSumofnum1andnum2.
pub.math:addObjects
WmPublic.Addsonejava.lang.Numberobjecttoanotherandreturnsthesum. Input Parameters num1 num2 java.lang.NumberNumbertoadd.SeeUsageNotesforsupported subclasses. java.lang.NumberNumbertoadd.SeeUsageNotesforsupported subclasses.
Output Parameters value java.lang.NumberSumofthenumericvaluesofnum1andnum2.
291
15 Math Folder
Usage Notes Thisserviceacceptsthefollowingsubclassesofjava.lang.Number:java.lang.Byte, java.lang.Double,java.lang.Float,java.lang.Integer,java.lang.Long,java.lang.Short. Thisserviceappliesthefollowingrulesforbinarynumericpromotiontotheoperands inorder: IfeitheroperandisoftypeDouble,theotherisconvertedtoDouble. Otherwise,ifeitheroperandisoftypeFloat,theotherisconvertedtoFloat. Otherwise,ifeitheroperandisoftypeLong,theotherisconvertedtoLong. Otherwise,bothoperandsareconvertedtotypeInteger. ThesepromotionrulesmirrortheJavarulesfornumericpromotionofnumerictypes.
pub.math:divideFloats
WmPublic.Dividesonefloatingpointnumber(representedasaString)byanother (num1/num2)andreturnsthequotient. Input Parameters num1 num2 StringNumber(floatingpointnumberrepresentedasaString)thatis thedividend. StringNumber(floatingpointnumberrepresentedasaString)thatis thedivisor.
Output Parameters value StringThequotientofnum1/num2.Ifaquotientcannotbeproduced, valuecontainsoneofthefollowing: Value

Infinity
Description Thecomputationproducesapositivevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesanegativevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesavaluethatunderflowsthe representablerangeofafloattype(forexample,dividing anumberbyinfinity). Thecomputationproducesavaluethatcannotbe representedasanumber(forexample,theresultofan illegaloperationsuchasdividingzerobyzeroorany operationthatusesNaNasinput,suchas10.0+NaN= NaN).
-Infinity
0.0
NaN
292
15 Math Folder
pub.math:divideInts
WmPublic.Dividesoneinteger(representedasaString)byanother(num1/num2)and returnsthequotient. Input Parameters num1 num2 StringNumber(integerrepresentedasaString)thatisthedividend. StringNumber(integerrepresentedasaString)thatisthedivisor.
Output Parameters value Usage Notes Makesurethestringsthatarepassedtotheserviceinnum1andnum2areinalocale neutralformat(thatis,usingthepattern####.##).Passinglocallyformattedstrings mayresultinunexpectedresults.Forexample,callingpub.math:addFloatsinaGerman localewiththearguments1,23and2,34willresultinthevalue357,not3.57or3,57. StringThequotientofnum1/num2.
pub.math:divideObjects
WmPublic.Dividesonejava.lang.Numberobjectbyanother(num1/num2)andreturnsthe quotient. Input Parameters num1 num2 java.lang.NumberNumberthatisthedividend.SeeUsageNotesfor supportedsubclasses. java.lang.NumberNumberthatisthedivisor.SeeUsageNotesfor supportedsubclasses.
Output Parameters value java.lang.NumberQuotientofnum1/num2.
293
15 Math Folder
Usage Notes Thisserviceacceptsthefollowingsubclassesofjava.lang.Number:java.lang.Byte, java.lang.Double,java.lang.Float,java.lang.Integer,java.lang.Long,java.lang.Short. Thisserviceappliesthefollowingrulesforbinarynumericpromotiontotheoperands inorder: IfeitheroperandisoftypeDouble,theotherisconvertedtoDouble. Otherwise,ifeitheroperandisoftypeFloat,theotherisconvertedtoFloat. Otherwise,ifeitheroperandisoftypeLong,theotherisconvertedtoLong. Otherwise,bothoperandsareconvertedtotypeInteger. ThesepromotionrulesmirrortheJavarulesfornumericpromotionofnumerictypes.
pub.math:multiplyFloatList
WmPublic.Multipliesalistoffloatingpointnumbers(representedinaStringlist)and returnstheproduct. Input Parameters numList String ListNumbers(floatingpointnumbersrepresentedasStrings)to multiply.
Output Parameters value StringProductofthenumbersinnumlist.Ifaproductcannotbe produced,valuecontainsoneofthefollowing: Value

Infinity
Description Thecomputationproducesapositivevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesanegativevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesavaluethatunderflowsthe representablerangeofafloattype(forexample, multiplyinganumberbyinfinity). Thecomputationproducesavaluethatcannotbe representedasanumber(forexample,theresultofan illegaloperationsuchasmultiplyingzerobyzeroorany operationthatusesNaNasinput,suchas10.0+NaN= NaN).
-Infinity
0.0
NaN
294
15 Math Folder
pub.math:multiplyFloats
WmPublic.Multiplesonefloatingpointnumber(representedasString)byanotherand returnstheproduct. Input Parameters num1 num2 StringNumber(floatingpointnumberrepresentedasaString)to multiply. StringNumber(floatingpointnumberrepresentedasaString)to multiply.
Output Parameters value StringProductofthenumericvaluesofnum1andnum2.Ifaproduct cannotbeproduced,valuecontainsoneofthefollowing: Value

Infinity
Description Thecomputationproducesapositivevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesanegativevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesavaluethatunderflowsthe representablerangeofafloattype(forexample, multiplyinganumberbyinfinity). Thecomputationproducesavaluethatcannotbe representedasanumber(forexample,theresultofan illegaloperationsuchasmultiplyingzerobyzeroorany operationthatusesNaNasinput,suchas10.0+NaN= NaN).
-Infinity
0.0
NaN
295
15 Math Folder
pub.math:multiplyIntList
WmPublic.Multipliesalistofintegers(representedinaStringlist)andreturnsthe product. Input Parameters numList String ListNumbers(floatingpointnumbersrepresentedasStrings)to multiply.
Output Parameters value Usage Notes Makesuretheresultofyourcalculationislessthan64bitsinwidth(themaximum widthforthelongdatatype).Iftheresultexceedsthislimit,itwillgenerateadata overflow. MakesurethestringsthatarepassedtotheserviceinnumListareinalocaleneutral format(thatis,usingthepattern####.##).Passinglocallyformattedstringsmay resultinunexpectedresults.Forexample,callingpub.math:addFloatsinaGermanlocale withthearguments1,23and2,34willresultinthevalue357,not3.57or3,57. StringProductofthenumbersinnumList.
pub.math:multiplyInts
WmPublic.Multipliesoneinteger(representedasaString)byanotherandreturnsthe product. Input Parameters num1 num2 StringNumber(integerrepresentedasaString)tomultiply. StringNumber(integerrepresentedasaString)tomultiply.
Output Parameters value StringProductofnum1andnum2.
296
15 Math Folder
Usage Notes Makesuretheresultofyourcalculationislessthan64bitsinwidth(themaximum widthforthelongdatatype).Iftheresultexceedsthislimit,itwillgenerateadata overflow. Makesurethestringsthatarepassedtotheserviceinnum1andnum2areinalocale neutralformat(thatis,usingthepattern####.##).Passinglocallyformattedstrings mayresultinunexpectedresults.Forexample,callingpub.math:addFloatsinaGerman localewiththearguments1,23and2,34willresultinthevalue357,not3.57or3,57.
pub.math:multiplyObjects
WmPublic.Multipliesonejava.lang.Numberobjectbyanotherandreturnstheproduct. Input Parameters num1 num2 java.lang.NumberNumbertomultiply.SeeUsageNotesfor supportedsubclasses. java.lang.NumberNumbertomultiply.SeeUsageNotesfor supportedsubclasses.
Output Parameters value Usage Notes Thisserviceacceptsthefollowingsubclassesofjava.lang.Number:java.lang.Byte, java.lang.Double,java.lang.Float,java.lang.Integer,java.lang.Long,java.lang.Short. Thisserviceappliesthefollowingrulesforbinarynumericpromotiontotheoperands inorder: IfeitheroperandisoftypeDouble,theotherisconvertedtoDouble. Otherwise,ifeitheroperandisoftypeFloat,theotherisconvertedtoFloat. Otherwise,ifeitheroperandisoftypeLong,theotherisconvertedtoLong. Otherwise,bothoperandsareconvertedtotypeInteger. ThesepromotionrulesmirrortheJavarulesfornumericpromotionofnumerictypes. java.lang.NumberProductofnum1andnum2.
297
15 Math Folder
pub.math:randomDouble
WmPublic.Returnsthenextpseudorandom,uniformlydistributeddoublebetween0.0 and1.0. Randomnumbergeneratorsareoftenreferredtoaspseudorandomnumbergenerators becausethenumbersproducedtendtorepeatthemselvesovertime. Input Parameters None. Output Parameters number StringGeneratedrandomnumber.
pub.math:subtractFloats
WmPublic.Subtractsonefloatingpointnumber(representedasaString)fromanother andreturnsthedifference. Input Parameters num1 num2 StringNumber(floatingpointnumberrepresentedasaString). StringNumber(floatingpointnumberrepresentedasaString)to subtractfromnum1.
Output Parameters value StringDifferenceofnum1num2.Ifadifferencecannotbeproduced, valuecontainsoneofthefollowing: Value

Infinity
Description Thecomputationproducesapositivevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesanegativevaluethat overflowstherepresentablerangeofafloattype. Thecomputationproducesavaluethatunderflowsthe representablerangeofafloattype(forexample, subtractinganumberfrominfinity). Thecomputationproducesavaluethatcannotbe representedasanumber(forexample,theresultofan illegaloperationsuchasmultiplyingzerobyzeroorany operationthatusesNaNasinput,suchas10.0NaN= NaN).
-Infinity
0.0
NaN
298
15 Math Folder
pub.math:subtractInts
WmPublic.Subtractsoneinteger(representedasaString)fromanotherandreturnsthe difference. Input Parameters num1 num2 StringNumber(integerrepresentedasaString). StringNumber(integerrepresentedasaString)tosubtractfromnum1.
Output Parameters value Usage Notes Makesuretheresultofyourcalculationislessthan64bitsinwidth(themaximum widthforthelongdatatype).Iftheresultexceedsthislimit,itwillgenerateadata overflow. Makesurethestringsthatarepassedtotheserviceinnum1andnum2areinalocale neutralformat(thatis,usingthepattern####.##).Passinglocallyformattedstrings mayresultinunexpectedresults.Forexample,callingpub.math:addFloatsinaGerman localewiththearguments1,23and2,34willresultinthevalue357,not3.57or3,57. StringDifferenceofnum1num2.
pub.math:subtractObjects
WmPublic.Subtractsonejava.lang.Numberobjectfromanotherandreturnsthe difference. Input Parameters num1 num2 java.lang.Number Number.SeeUsageNotesforsupportedsub classes. java.lang.Number Numbertosubtractfromnum1.SeeUsageNotes forsupportedsubclasses.
299
15 Math Folder
Output Parameters value Usage Notes Thisserviceacceptsthefollowingsubclassesofjava.lang.Number:java.lang.Byte, java.lang.Double,java.lang.Float,java.lang.Integer,java.lang.Long,java.lang.Short. Thisserviceappliesthefollowingrulesforbinarynumericpromotiontothe operands.Thefollowingrulesareappliedinorder: IfeitheroperandisoftypeDouble,theotherisconvertedtoDouble. Otherwise,ifeitheroperandisoftypeFloat,theotherisconvertedtoFloat. Otherwise,ifeitheroperandisoftypeLong,theotherisconvertedtoLong. Otherwise,bothoperandsareconvertedtotypeInteger. ThesepromotionrulesmirrortheJavarulesfornumericpromotionofnumerictypes. java.lang.NumberDifferenceofnum1num2.
300
16
MIME Folder
YouusetheelementsinthemimefoldertocreateMIMEmessagesandextract informationfromMIMEmessages.
301
16 MIME Folder

Thefollowingelementsareavailableinthisfolder: Service pub.mime:addBodyPart pub.mime:addMimeHeader pub.mime:createMimeData pub.mime:getBodyPartContent pub.mime:getBodyPartHeader pub.mime:getContentType pub.mime:getEnvelopeStream pub.mime:getMimeHeader pub.mime:getNumParts pub.mime:getPrimaryContentType pub.mime:getSubContentType pub.mime:mergeHeaderAndBody Function WmPublic.Addsabodypart(headerfieldsand content)toaspecifiedMIMEobject. WmPublic.Addsoneormoreheaderfieldstoa specifiedMIMEobject. WmPublic.CreatesaMIMEobject. WmPublic.Retrievesthecontent(payload)fromthe specifiedMIMEobject. WmPublic.Returnsthelistofheaderfieldsforthe specifiedbodypart. WmPublic.ReturnsthevalueoftheContentType messageheaderfromthespecifiedMIMEobject. WmPublic.GeneratesanInputStreamrepresentationof aMIMEmessagefromaspecifiedMIMEobject. WmPublic.Returnsthelistofmessageheadersfroma specifiedMIMEobject. WmPublic.Returnsthenumberofbodypartsinthe specifiedMIMEobject. WmPublic.ReturnsthetoplevelportionofaMIME objectsContentTypevalue. WmPublic.ReturnsthesubtypeportionofaMIME objectsContentTypevalue. WmPublic.Concatenatesthecontentsoftheheaderand bodyreturnedbythepub.client:httpservice.
302
16 MIME Folder
pub.mime:addBodyPart
WmPublic.Addsabodypart(headerfieldsandcontent)toaspecifiedMIMEobject. Input Parameters mimeData content DocumentMIMEobjecttowhichyouwanttoaddabodypart.(This IDataobjectisproducedbypub.mime:createMimeData.) java.io.InputStreamorObjectContentthatyouwanttoaddtothe MIMEobject.contentcanbeanInputStreamoranotherMIMEobject. UseanInputStreamtoaddanordinarypayload.UseaMIMEobject toaddapayloadthatisitselfaMIMEmessage. StringFlagthatspecifieswhethercontentistobetreatedasaMIME entity. Important! ThisparameterisonlyusedifcontentisanInputStream. Setthisparametertooneofthefollowingvalues: Set to...
yes
isEnvStream
To... TreatcontentasaMIMEentity.addBodyPartwillstrip outtheheaderfieldsfromthetopofcontentandadd themtomimeDataaspartheaders.Theremainingdata willbetreatedasthepayload. Note: addBodyPartassumesthatalldatauptothefirst blanklinerepresentstheentitysheaderfields.
no
Treatcontentasanordinarypayload.
mimeHeader
DocumentSpecifiesthepartheadersthatyouwanttoaddwiththis bodypart.Keynamesrepresentthenamesoftheheaderfields.The valuesofthekeysrepresentthevaluesoftheheaderfields. Forexample,ifyouwantedtoaddthefollowingheaderfields:

X-Doctype: RFQ X-Severity: 10
YouwouldsetmimeHeaderasfollows: Key XDoctype XSeverity Value

RFQ 10
303
16 MIME Folder
BeawarethatthefollowingMIMEheadersareautomatically insertedbypub.mime:getEnvelopeStreamwhenitgeneratestheMIME message:

Message-ID MIME-Version
Additionally,youusethecontent,encoding,anddescription parameterstosetthefollowingfields:
Content-Type Content-Transfer-Encoding Content-Description
IfyousettheseheaderfieldsinmimeHeaderandyoucreateasingle partmessage,thevaluesincontenttype,encoding,anddescription,if specified,willoverridethoseinmimeHeader.Seeusagenotes. contenttype StringOptional.ThevalueoftheContentTypeheaderforthisbody part.Forsinglepartmessages,thisvalueoverridestheContentType valueinmimeHeader,ifoneispresent.Defaultstotext/plain. Seeusagenotes. encoding StringOptional.Specifieshowthebodypartistobeencodedfor transportandsetsthevalueoftheContentTransferEncoding header.Forsinglepartmessages,thisvalueoverridestheContent TransferEncodingvalueinmimeHeader,ifoneispresent.Defaultsto 7bit. Seeusagenotes. Note: Thisparameterdetermineshowthepayloadistobeencoded fortransport.WhenyouaddapayloadtomimeData,itshouldbein itsoriginalformat.Thepub.mime:getEnvelopeStreamservicewill performtheencoding(asspecifiedbyencoding)whenitgenerates thefinalMIMEmessage. Set to...
7bit
To... Default.Specifythatcontentis7bit,lineorientedtext thatneedsnoencoding. Specifythatcontentis8bit,lineorientedtextthat needsnoencoding. Note: Thisencodingvalueisnotrecommendedfor messagesthatwillbetransportedviaSMTPoverthe Internet,becausethedatacanbealteredby interveningmailserversthatcantaccommodate8bit text.Tosafelytransport8bittext,usequotedprintable encodinginstead.
8bit
304
16 MIME Folder
binary
Specifythatcontentcontainsbinaryinformationthat needsnoencoding. Note: Thisencodingvalueisnotrecommendedfor messagesthatwillbetransportedviaSMTPoverthe Internet,becausethedatacanbealteredby interveningmailserversthatcantaccommodate binarydata.Tosafelytransportbinarydata,use base64encodinginstead.
quotedprintable
Specifythatcontentcontains7or8bit,lineoriented textthatyouwanttoencodeusingthequoted printableencodingscheme. Specifythatcontentcontainsanarbitrarysequenceof octetsthatyouwanttoencodeusingthebase64 encodingscheme. Specifythatcontentcontainsanarbitrarysequenceof octetsthatyouwanttoencodeusingtheuuencode encodingscheme.
base64
uuencode
description multipart
StringOptional.SpecifiesthevalueoftheContent-Description headerforthisbodypart. StringOptional.FlagthatdetermineshowaddBodyPartbehavesif mimeDataalreadycontainsoneormorebodyparts. Bydefault,addBodyPartsimplyappendsanewbodyparttomimeData ifitalreadycontainsapayload.(Thisallowsyoutoconstructmulti partmessages.)However,youcanoverridethisbehaviorifyouwant toeitherreplacetheexistingpayloadwiththenewbodypartor throwanexceptionunderthesecircumstances(seereplace parameter,below). Set to...
yes no
To... Default.AppendanewbodyparttomimeData. Replacetheexistingpayloadwiththenewbodypart. (Dependingonthevalueofreplace,thissettingmay causeaddBodyPart tothrowanexception.)
replace
StringOptional.FlagthatspecifieswhetheraddBodyPartreplacesthe existingpayloadorthrowsanexceptionwhenitreceivesamimeData thatalreadycontainsapayload.Thisparameterisonlyusedwhen multipartissettono.
305
16 MIME Folder
Set to...
yes
To... Default.Replacetheexistingpayloadwiththenew bodypart. Throwanexception.
no
Output Parameters mimeData Usage Notes ThisserviceoperatesontheMIMEobject(mimeData)producedby pub.mime:createMimeData. Thewayinwhichthecontenttypeandencodingparametersareapplieddependson whetherthefinishedmessageissinglepartormultipart. Forsinglepartmessages: contenttypespecifiestheContentTypefortheentireMIMEmessage.Itoverrides anyvalueassignedtotheContentTypeheaderinmimeHeader.IfContentTypeis notspecifiedincontenttypeormimeHeader,thevalueoftheContentTypeheader defaultstotext/plain. encodingspecifiestheContentTransferEncodingfortheentireMIMEmessage.It overridesanyvalueassignedtotheContentTransferEncodingheaderin mimeHeader.IfContentTransferEncodingisnotspecifiedinencodingor mimeHeader,thevalueoftheContentTransferEncodingheaderdefaultsto7bit. Formultipartmessages: contenttypespecifiestheContentTypeforanindividualbodypart.TheContent TypefortheentireMIMEmessageisautomaticallysettomultipart/mixed,orto multipart/subTypeifasubtypewasspecifiedwhentheMIMEobjectwascreated. Seepub.mime:createMimeData. encodingspecifiestheContentTransferEncodingforanindividualbodypart.The ContentTransferEncodingheaderinmimeHeader,ifpresent,specifiesthe encodingfortheentireMIMEmessage.IfContentTransferEncodingisnot specifiedinmimeHeader,orifthespecifiedvalueisnotvalidforamultipart message,thevalueoftheContentTransferEncodingheaderdefaultsto7bit.(7bit, 8bit,andbinaryaretheonlyencodingvaluesvalidformultipartmessages.) ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. See Also pub.mime:createMimeData pub.mime:getBodyPartContent pub.mime:addMimeHeader DocumentMIMEobjecttowhichthebodypartwasadded.
306
16 MIME Folder
Examples Forexamplesofhowtousethisservice,seethefollowingservices,whichresideinthe certifiedsamplesareaoftheKnowledgeBaseontheAdvantageWebSite. samples.mime:build_SimpleMIME samples.mime:build_MultipartMIME
pub.mime:addMimeHeader
WmPublic.AddsoneormoreheaderfieldstoaspecifiedMIMEobject. Input Parameters mimeData mimeHeader DocumentMIMEobjecttowhichyouwanttheheaderfieldsadded. (ThisIDataobjectisproducedbypub.mime:createMimeData.) DocumentHeaderfieldsthatyouwanttoaddtotheMIMEobject. Keynamesrepresentthenamesoftheheaderfields.Thevaluesof thekeysrepresentthevaluesoftheheaderfields.Forexample,to addthefollowingheaderfields:
YouwouldsetmimeHeaderasfollows: Key XDoctype XSeverity Description

RFQ 10
BeawarethatthefollowingMIMEheadersareautomatically insertedbypub.mime:getEnvelopeStreamwhenitgeneratestheMIME message:

IfyousetthesevaluesinmimeHeader,pub.mime:getEnvelopeStreamwill overwritethematruntime. Output Parameters mimeData DocumentMIMEobjecttowhichtheheaderfieldswereadded.
307
16 MIME Folder
Usage Notes ThisserviceoperatesontheMIMEobject(mimeData)producedby pub.mime:createMimeData. IfyouaddMIMEheadersbeforeyouaddmultiplebodyparts,theheaderfieldswill beaddedtoeachofthebodyparts.Ifyoudonotwantthisbehavior,eitherdrop mimeHeaderfromthepipelineimmediatelyafteryouexecuteaddMimeHeader,orinvoke addMimeHeaderafteryouveaddedallbodypartstotheMIMEobject. Beawarethatthecontenttypeandencodingparametersusedbythepub.mime:addBodyPart servicewilloverrideanyContentTypeorContentTransferEncodingsettingsin mimeData.Moreover,incertaincases,thepub.mime:getEnvelopeStreamwilloverridethese settingswhenitgeneratesamultipartmessage.Forinformationabouthowthe ContentTypeorContentTransferEncodingheadersarederivedatruntime,seethe UsageNotesunderpub.mime:addBodyPart. ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. See Also pub.mime:createMimeData pub.mime:getMimeHeader pub.mime:addBodyPart Examples Forexamplesofhowtousethisservice,seethefollowingservices,whichresideinthe certifiedsamplesareaoftheKnowledgeBaseontheAdvantageWebSite. samples.mime:build_SimpleMIME
pub.mime:createMimeData
WmPublic.CreatesaMIMEobject. Ifnoinputparameterispassedtothisservice,theservicecreatesanemptyMIMEobject. Otherwise,theservicecreatesaMIMEobjectcontainingtheelements(headerfieldsand content)fromtheMIMEmessageininput. IfyouarebuildingaMIMEmessage,youusethisservicetocreateanemptyMIME object.YoupopulatetheemptyMIMEobjectwithheaderfieldsandcontent,andthen passittopub.mime:getEnvelopeStream,whichproducesthefinishedMIMEmessage. IfyouareextractingdatafromaMIMEmessage,youusethisservicetoparsethe originalMIMEmessageintoaMIMEobjectsothatyoucanextractitsheaderfields andcontentusingotherwebMethodsservices.
308
16 MIME Folder
Input Parameters input mimeHeader java.io.InputStreamOptional.MIMEentityyouwanttoparse.Ifinputis notprovided,createMimeDatacreatesanemptyMIMEobject. DocumentOptional.Specifiesheaderfieldsthatyouwanttoaddtothe MIMEobject.Keynamesrepresentthenamesoftheheaderfields.The valuesofthekeysrepresentthevaluesoftheheaderfields. Note: Thisparameterisignoredwheninputispassedtothisservice. Forexample,ifyouwantedtoaddthefollowingheaderfields:
YouwouldsetmimeHeaderasfollows: Key XDoctype XSeverity Value

RFQ 10
BeawarethatthefollowingMIMEheadersareautomaticallyinserted bypub.mime:getEnvelopeStreamwhenitgeneratestheMIMEmessage:
IfyousetthesevaluesinmimeHeader,pub.mime:getEnvelopeStreamwill overwritethematruntime. subType StringOptional.StringthatspecifiesthesubtypeportionoftheContent Typeheader,whenthemessageisamultipartmessageand\youwant somethingotherthanthedefaultvalueofmixed.Forexample,ifyou wanttheContentTypeheadertobemultipart/relatedintheresulting message,setsubTypetorelated. subTypeisignorediftheresultingmessageisnotamultipartmessage. Output Parameters mimeData DocumentMIMEobject.IfinputwaspassedtocreateMimeData,mimeData willcontaintheparsedMIMEmessage.Ifinputwasnotpassedto createMimeData,mimeDatawillbeempty. StringConditional.Indicateswhetherinputwasanencryptedmessage. Thisparameterisnotpresentwhentheservicecreatesanew,empty MIMEobject. A value of... Indicates that...
true
encrypted
Themessageisencrypted(theoriginalmessagestreamisin stream).
309
16 MIME Folder
false
Themessageisnotencrypted.
signed
StringConditional.Flagwhosevalueindicateswhetherinputwasa signedmessage.Thisparameterisnotpresentwhentheservicecreatesa new,emptyMIMEobject. A value of... Indicates that...

true
Themessageissigned(theoriginalmessagestreamisin stream). Themessageisnotsigned.
false
certsOnly
StringConditional.Flagwhosevalueindicateswhetherinputcontained onlydigitalcertificates.(Thistypeofmessagecanbeproducedbythe pub.smime:createCertsOnlyDataserviceandallowsdigitalcertificatestobe transportedviathenetworkasaMIMEmessage.)Thisparameterisnot presentwhentheservicecreatesanew,emptyMIMEobject. A value of... Indicates that...

true false
Themessagecontainsonlycertificates. Themessagecontainsaregularpayload.
stream
java.io.InputStreamConditional.InputStreamcontainingtheoriginal MIMEmessagefrominput.Thisparameterispresentonlywheninputis anS/MIMEmessage.
Usage Notes AlloftheotherMIMEservicesoperateonthemimeDataIDataobjectproducedbythis service.TheydonotoperatedirectlyonMIMEmessagestreams. Important! YoucanexaminethecontentsofmimeDataduringtestingand debugging.However,becausetheinternalstructureofmimeDataissubjectto changewithoutnotice,do notexplicitlysetormapdatato/fromtheseelementsin yourservice.TomanipulateoraccessthecontentsofmimeData,useonlytheMIME servicesthatIntegrationServerprovides. ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. See Also pub.mime:addMimeHeader pub.mime:addBodyPart pub.mime:getMimeHeader pub.mime:getBodyPartContent pub.mime:getEnvelopeStream
310
16 MIME Folder
Examples Forexamplesofhowtousethisservice,seethefollowingservices,whichresideinthe certifiedsamplesareaoftheKnowledgeBaseontheAdvantageWebSite. samples.mime:build_SimpleMIME samples.mime:build_MultipartMIME samples.mime:extract_SimpleMIME samples.mime:extract_MultipartMIME
pub.mime:getBodyPartContent
WmPublic.Retrievesthecontent(payload)fromthespecifiedMIMEobject. Youusethisserviceforbothsinglepartandmultipartmessages. Toretrievecontentfromamultipartmessage,yousettheindex(toselectthepartby indexnumber)orcontentID(toselectthepartbycontentIDvalue)parametertospecifythe bodypartwhosecontentyouwanttoretrieve.Togetthecontentfromasinglepart message,youomittheindexandcontentIDparametersorsetindexto0. Input Parameters mimeData index DocumentMIMEobjectwhosecontentyouwanttoretrieve.(ThisIData objectisproducedbypub.mime:createMimeData.) StringOptional.Indexnumberofthebodypartwhosecontentyou wanttoretrieve(ifyouwanttoretrievethecontentfromaspecific bodypart).Thefirstbodypartisindexnumberzero. Note: IfcontentIDisspecified,indexisignored. contentID StringOptional.ValueoftheContent-IDheaderfieldofthebodypart whosecontentyouwanttoretrieve(ifyouwanttoretrievethe payloadfromaspecificbodypart).
Output Parameters content encrypted java.io.InputStreamThepayloadofthespecifiedbodypart. StringFlagwhosevalueindicateswhethercontentisanencrypted MIMEmessage. A value of...

true false
Indicates that... contentisanencryptedmessage. contentisnotanencryptedmessage.
311
16 MIME Folder
signed
StringFlagindicatingwhethercontentisasignedMIMEmessage. A value of...

true false
Indicates that... contentisasignedMIMEmessage. contentisnotasignedMIMEmessage.
certsOnly
StringFlagwhosevalueindicateswhethercontentisacertsonly MIMEmessage. A value of...

true false
Indicates that... contentisacertsonlymessage. contentisnotacertsonlymessage.
Usage Notes ThisserviceoperatesontheMIMEobject(mimeData)producedby pub.mime:createMimeData. IfyouomitindexorcontentIDwhenretrievingcontentfromamultipartmessage, getBodyPartContentreturnsthepayloadfromthefirstbodypart.Ifyouuseindexor contentIDtoselectabodypartthatdoesnotexistinmimeData,contentwillbenull. ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. See Also pub.mime:createMimeData pub.mime:addBodyPart pub.mime:getBodyPartHeader Examples Forexamplesofhowtousethisservice,seethefollowingservices,whichresideinthe certifiedsamplesareaoftheKnowledgeBaseontheAdvantageWebSite. samples.mime:extract_SimpleMIME samples.mime:extract_MultipartMIME
312
16 MIME Folder
pub.mime:getBodyPartHeader
WmPublic.Returnsthelistofheaderfieldsforthespecifiedbodypart. Input Parameters mimeData index DocumentMIMEobjectwhosemessageheadersyouwanttoretrieve. (ThisIDataobjectisproducedbypub.mime:createMimeData) StringOptional.Indexnumberofthebodypartwhoseheaderfields youwanttoretrieve.Thefirstbodypartisindexzero. Note: IfcontentIDisspecified,indexisignored. contentID decodeHeaders StringOptional.ValueoftheContent-IDheaderfieldofthebodypart whoseheaderfieldsyouwanttoretrieve. StringConditional.Flagwhosevalueindicateswhethertodecode encodedheadersintheMIMEobject. A value of... true false Output Parameters mimeHeader DocumentIDataobjectcontainingthemessageheaders.Keynames representthenamesoftheheaderfields.Thevalueofakey representsthevalueofthatheaderfield. Forexample,iftheoriginalmessagecontainedthefollowing messageheaderfields:
Content-Type: text/xml X-Doctype: RFQ X-Severity: 0
Indicates that... Theheadersshouldbedecoded. Default.Theheadersshouldnotbedecoded.
get Body Part HeaderwouldreturnthefollowingIDataobject: Key ContentType XDoctype XSeverity Value

text/xml RFQ 0
313
16 MIME Folder
Usage Notes ThisserviceoperatesontheMIMEobject(mimeData)producedby pub.mime:createMimeData. IfyouomitindexorcontentID,getBodyPartHeaderreturnsthemessageheadersfromthe firstbodypart.IfyouuseindexorcontentIDtoselectabodypartthatdoesnotexistin mimeData,contentwillbenull. ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. See Also pub.mime:createMimeData pub.mime:addBodyPart pub.mime:getMimeHeader
pub.mime:getContentType
WmPublic.ReturnsthevalueoftheContentTypemessageheaderfromthespecified MIMEobject. Input Parameters mimeData DocumentMIMEobjectwhoseContentTypeyouwanttodiscover. (ThisIDataobjectisproducedbypub.mime:createMimeData.)
Output Parameters contentType StringValueoftheMIMEobjectsContentTypeheaderfield.Notethat thisservicereturnsonlythemediatypeandsubtypeportionofthis headerfieldsvalue.Itdoesnotreturnanyparametersthevaluemay include.Forexample,ifthemessagesContentTypeheaderwere:

Content-Type: text/plain;charset=UTF8
contentTypewouldcontain:
text/plain
Usage Notes ThisserviceoperatesontheMIMEobject(mimeData)producedby pub.mime:createMimeData. ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide.
314
16 MIME Folder
See Also pub.mime:createMimeData pub.mime:getSubContentType pub.mime:getPrimaryContentType pub.mime:getMimeHeader pub.mime:getBodyPartHeader
pub.mime:getEnvelopeStream
WmPublic.GeneratesanInputStreamrepresentationofaMIMEmessagefroma specifiedMIMEobject. Input Parameters mimeData index DocumentMIMEobjectfromwhichyouwanttogeneratetheMIME message.(ThisIDataobjectisproducedbypub.mime:createMimeData.) StringOptional.Indexnumberofthebodypartforwhichyouwant togeneratetheMIMEmessage(ifyouwanttogeneratethemessage fromaspecificbodypart).Thefirstbodypartisindexnumberzero. StringOptional.ValueoftheContent-IDheaderfieldofthebodypart fromwhichyouwanttogeneratetheMIMEmessage(ifyouwantto generatethemessagefromaspecificbodypart). Note: Ifindexisspecified,contentIDisignored. suppressHeaders String ListOptional.Namesofheaderfieldsthataretobeomitted frommessage.Youcanusethisoptiontoexcludeheaderfieldsthat getEnvelopeStreamgeneratesbydefault,suchasContent-Typeand content-encoding.
contentID
315
16 MIME Folder
createMultipart
StringOptional.Specifieswhetheramultipartmessageistobe created,evenifmimeDatacontainsonlyonebodypart. Set to...

yes
To... Createamultipartmessage(ContentTypemessage headerissettomultipart/mixed). Default.Createamessagebasedonthenumberof bodypartsinmimeData. Ifthemessagecontainsonlyonebodypart, ContentTypeissetaccordingtothecontenttype settingspecifiedwhenthatbodypartwasaddedto mimeData. Ifthemessagecontainsmultiplebodyparts, ContentTypeisautomaticallysetto multipart/mixed.
no
Output Parameters envStream Usage Notes ThisserviceoperatesontheMIMEobject(mimeData)producedby pub.mime:createMimeData. IfyouomitindexorcontentID,getEnvelopeStreamgeneratestheMIMEmessagefromthe entirecontentsofthemimeData.IfyouuseindexorcontentIDtoselectabodypartthat doesnotexistinmimeData,contentwillbenull. getEnvelopeStreamautomaticallyinsertstheMIME-Version and Message-IDmessage headersintotheMIMEmessageitputsintoenvStream. ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. See Also pub.mime:createMimeData pub.mime:addBodyPart pub.mime:addMimeHeader Examples Forexamplesofhowtousethisservice,seethefollowingservices,whichresideinthe certifiedsamplesareaoftheKnowledgeBaseontheAdvantageWebSite. samples.mime:build_SimpleMIME samples.mime:build_MultipartMIME java.io.InputStreamTheMIMEmessageasanInputStream.
316
16 MIME Folder
pub.mime:getMimeHeader
WmPublic.ReturnsthelistofmessageheadersfromaspecifiedMIMEobject. Input Parameters mimeData Output Parameters mimeHeader DocumentConditional.AnIDataobjectcontainingthemessage headers.Keynamesrepresentthenamesoftheheaderfields.The valueofakeyrepresentsthevalueoftheheaderfields. Forexample,iftheoriginalmessagecontainedthefollowing messageheaderfields:
Message-ID: <002e01c0f150$6f33010a@sgx.com> From: "Purch01@GSX.com" <Purch01@GSX.com>To: <EXPEst@exprint.com> MIME-Version: 1.0 Content-Type: text/xml X-Doctype: RFQ X-Severity: 0
DocumentMIMEobjectwhosemessageheadersyouwanttoretrieve. (ThisIDataobjectisproducedbypub.mime:createMimeData.)
getMimeHeaderwouldreturnthefollowing: Key
Message-ID From To MIMEVersion ContentType X-Doctype X-Severity
Value
<002e01c0f150$6f33010a@sgx.com> "Purch01@GSX.com" <Purch01@GSX.com> <EXPEst@exprint.com> 1.0 text/xml RFQ 0
Usage Notes ThisserviceoperatesontheMIMEobject(mimeData)producedby pub.mime:createMimeData. ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide.
317
16 MIME Folder
See Also pub.mime:createMimeData pub.mime:addMimeHeader pub.mime:getBodyPartHeader
pub.mime:getNumParts
WmPublic.ReturnsthenumberofbodypartsinthespecifiedMIMEobject. Input Parameters mimeData Output Parameters numParts Usage Notes ThisserviceoperatesontheMIMEobject(mimeData)producedbycreateMimeData. ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. See Also pub.mime:createMimeData pub.mime:getBodyPartContent pub.mime:addBodyPart Examples Forexamplesofhowtousethisservice,seethefollowingservice,whichresidesinthe certifiedsamplesareaoftheKnowledgeBaseontheAdvantageWebSite. samples.mime:extract_MultipartMIME StringThenumberofbodypartsintheMIMEobject. DocumentMIMEobjectwhosepartsyouwanttocount.(ThisIData objectisproducedbypub.mime:createMimeData.)
318
16 MIME Folder
pub.mime:getPrimaryContentType
WmPublic.ReturnsthetoplevelportionofaMIMEobjectsContentTypevalue. Input Parameters mimeData Output Parameters primContentType StringMessagestoplevelContentType.Forexample,ifthe messagesContentTypeheaderwere:
Content-Type: multipart/mixed
DocumentMIMEobjectwhoseContentTypeyouwanttodiscover. (ThisIDataobjectisproducedbypub.mime:createMimeData.)
primContentTypewouldcontain:
multipart
Usage Notes ThisserviceoperatesontheMIMEobject(mimeData)producedby pub.mime:createMimeData. ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. See Also pub.mime:createMimeData pub.mime:getContentType pub.mime:addMimeHeader pub.mime:getBodyPartHeader
pub.mime:getSubContentType
WmPublic.ReturnsthesubtypeportionofaMIMEobjectsContentTypevalue. Input Parameters mimeData DocumentMIMEobjectwhosesubtypeyouwanttodiscover.(This IDataobjectisproducedbypub.mime:createMimeData.)
319
16 MIME Folder
Output Parameters subContentType StringMessagessubtype.Forexample,ifthemessagesContent Typeheaderwere:

Content-Type: multipart/mixed
subContentTypewouldcontain:
mixed
Usage Notes ThisserviceoperatesontheMIMEobject(mimeData)producedby pub.mime:createMimeData. ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuidee. See Also pub.mime:createMimeData pub.mime:getContentType pub.mime:addMimeHeader pub.mime:getBodyPartHeader
pub.mime:mergeHeaderAndBody
WmPublic.Concatenatesthecontentsoftheheaderandbodyreturnedbythe pub.client:httpservice. Youcanusethisservicetoreassemblethemessageintoitsoriginalformsothatitcanbe usedasinputtothepub.mime:createMimeDataservice(oranyotherservicethatrequiresthe entirehttpresponseasanInputStream). Input Parameters headerLines DocumentIDataobjectcontainingthemessageheadersreturnedby pub.client:http.(Themessageheadersarereturnedinthelines documentinsidetheheaderoutputparameterthatisproducedby pub.client:http.) DocumentIDataobjectcontainingthebodyofthemessagereturned bypub.client:http.Thisdocumentmustcontainthebodyofthe messageinoneofthefollowingkeys: Key bytes stream Description byte[ ]Optional.Bodyofthemessage(ifpub.client:http returnedthebodyasabyte[]). java.io.InputStreamOptional.Thebodyofthemessage(if pub.client:httpreturnedthebodyasanInputStream).
body
320
16 MIME Folder
Output Parameters stream Usage Notes Usethisservicetomergetheresultsproducedbypub.client:httptogettheoriginal MIMEmessage. See Also pub.client:http pub.mime:createMimeData java.io.InputStream InputStreamcontainingthereassembledtap message.
321
16 MIME Folder
322
17
Packages Folder
Youusetheelementsinthepackagesfoldertoinstall,load,and/oralterthestatusofa packageontheIntegrationServer.
323
17 Packages Folder

Thefollowingelementsareavailableinthisfolder: Element pub.packages:activatePackage pub.packages:disablePackage pub.packages:enablePackage pub.packages:installPackage pub.packages:recoverPackage pub.packages:reloadPackage Package and Description WmPublic.Activates(makesavailabletoclients)an inactivepackage. WmPublic.Disablesapackage,thusprohibitingaccess totheservicesinthepackage. WmPublic.Enablesapackagethathasbeendisabled. WmPublic.Installsapackagethathasbeenpublished tothisserver. WmPublic.Recoversapackagethatexistsinthe serverssalvagedirectory. WmPublic.Loadsanewcopyofthepackageinto memoryfromdisk.
pub.packages:activatePackage
WmPublic.Activates(makesavailabletoclients)aninactivepackage. Youusethisservicetoactivateapackagethatwasnotactivatedwhenitwasinitially installedorrecovered. Note: Thisserviceactivatespackagesfromaninactivestate(thatis,packagesthatare installedontheserverbutarenotregisteredintheactivepackagelist).Toenablea packagethatisinadisabledstate,youusepub.packages:enablePackage. Input Parameters package StringNameofthepackagethatyouwanttoactivate.Packagenamesare casesensitive.
Output Parameters message StringMessagefromserver.(Thisisthesamemessagethatyoureceive whenyouactivateapackagewiththeIntegrationServerAdministrator.)
324
17 Packages Folder
Usage Notes Thisservicewillthrowanexceptionifthepackagespecifiedinpackagedoesnotexist orcannototherwisebeactivated. Whenapackageisactivated,itisloadedintomemoryinanenabledstate(thatis, activatePackageautomaticallyactivatesandenablesthepackage.)Youdonotneedto explicitlyenableitwithpub.packages:enablePackage. See Also pub.packages:enablePackage pub.packages:installPackage pub.packages:recoverPackage
pub.packages:disablePackage
WmPublic.Disablesapackage,thusprohibitingaccesstotheservicesinthepackage. Input Parameters package StringNameofthepackagethatyouwanttodisable.Packagenamesare casesensitive.
Output Parameters message Usage Notes Whenapackageisdisabled,theservicesinthepackagearenolongeravailabletothe clients.Toreenableapackagethathasbeendisabled,usepub.packages:enablePackage. Important! NeverdisabletheWmRootpackage.Doingsowoulddisabletheserver. Beawarethatifyoudisableapackagewhileservicesinthepackagearebeing executed,thoseserviceswillmostlikelyfail.disablePackagedoesnotwaitforin progressservicestofinishbeforedisablingapackage. Thisservicewillthrowanexceptionifthepackagespecifiedinpackagedoesnotexist orcannototherwisebedisabled. See Also pub.packages:enablePackage StringMessagefromserver.(Thisisthesamemessagethatyoureceive whenyoudisableapackagewiththeIntegrationServerAdministrator.)
325
17 Packages Folder
pub.packages:enablePackage
WmPublic.Enablesapackagethathasbeendisabled. Note: Thisserviceenablesapackagethatisinadisabledstate(thatis,apackagethat hasbeendisabledthroughtheIntegrationServerAdministratororthe pub.packages:disablePackageservice).Toactivateapackagethatisinaninactivestate, youuseenablePackage. Input Parameters package StringNameofthepackagethatyouwanttoenable.Packagenamesare casesensitive.
Output Parameters message Usage Notes Whenyouenableapackage,thepackageisreloadedintomemoryfromdisk. Thisservicewillthrowanexceptionifthepackagespecifiedinpackagedoesnotexist, hasnotbeenactivated,orcannototherwisebeenabled. See Also pub.packages:disablePackage pub.packages:activatePackage pub.packages:reloadPackage StringMessagefromserver.(Thisisthesamemessagethatyoureceive whenyouenableapackagewiththeIntegrationServerAdministrator.)
326
17 Packages Folder
pub.packages:installPackage
WmPublic.Installsapackagethathasbeenpublishedtothisserver. Input Parameters packageFile StringNameofthedistributionfilethatcontainsthepackagethat youwanttoinstall.Thisfilemustresideintheserversinbound directory(IntegrationServer_directory\replicate\inbound). WhenspecifyingpackageFile, Doincludethe.zipextensioninthefilename. Do notincludethedirectorypath. Forexample:myPackageFileAug2001.zip activateOnInstall StringFlagthatspecifieswhetheryouwanttheserverto automaticallyactivatethepackageafteritisinstalled. Set to...
yes
To... Activatethepackageafterinstallationandmakeit immediatelyavailabletoclients. Installthepackagewithoutactivatingitafterwards.If youinstallapackageinthismode,itwillnotbe accessibleuntilitisexplicitlyactivatedthroughthe IntegrationServerAdministratororthe pub.packages:activatePackageservice.
no
Output Parameters message Usage Notes Iftheinstalledpackagereplacesanexistingpackageontheserver,installPackagewill automaticallyputabackupcopyoftheexistingpackagein IntegrationServer_directory\replicate\salvagebeforeitinstallsthenewpackage. ThisservicewillthrowanexceptionifthefilenamedinpackageFiledoesnotexistor cannototherwisebeinstalledcorrectly. See Also pub.packages:activatePackage pub.packages:recoverPackage StringMessagefromserver.(Thisisthesamemessagethatisdisplayed whenyouinstallapackagewiththeIntegrationServerAdministrator.)
327
17 Packages Folder
pub.packages:recoverPackage
WmPublic.Recoversapackagethatexistsintheserverssalvagedirectory. Thesalvagedirectory(IntegrationServer_directory\replicate\salvage)iswheretheserver keepspackagesthataredeletedwiththesafedeleteoptionorreplacedwithnewer installedversions. Input Parameters package activateOnRecover StringNameofthepackagethatyouwanttorecover.Package namesarecasesensitive. StringFlagthatspecifieswhetheryouwanttheserverto automaticallyactivatethepackageafteritisrecovered. Set to...
yes
To... Activatethepackageafteritisrecoveredandmakeit immediatelyavailabletoclients. Recoverthepackagewithoutactivatingitafterwards.If yourecoverapackageinthismode,itwillnotbe accessibleuntilitisexplicitlyactivatedthroughthe IntegrationServerAdministratororthe pub.packages:activatePackageservice.
no
Output Parameters message Usage Notes Youcanonlyrecoverpackagesthatexistintheserverssalvagedirectory. Ifyourecoverapackagethatiscurrentlyinstalledontheserver,thepackagefromthe salvagedirectoryreplacestheversionthatiscurrentlyinstalled.(Beawarethatthe serverdoesnotretainacopyoftheversionthatitreplaces.) Thisservicewillthrowanexceptionifthefilenamedinpackagedoesnotexistinthe serverssalvagedirectoryorcannototherwiseberecovered. See Also pub.packages:activatePackage StringMessagefromserver.(Thisisthesamemessagethatisdisplayed whenyourecoverapackagewiththeIntegrationServerAdministrator.)
328
17 Packages Folder
pub.packages:reloadPackage
WmPublic.Loadsanewcopyofthepackageintomemoryfromdisk. Ifyoumakechangestotheserviceinapackagewhiletheserverisrunning,youmustuse reloadPackagetoputthosechangesintoeffect. Input Parameters package StringNameofthepackagethatyouwanttoreload.Packagenamesare casesensitive.
Output Parameters message Usage Notes Beawarethatifyoureloadapackagewhileservicesinthepackagearebeing executed,thoseserviceswillmostlikelyfail.reloadPackagedoesnotwaitforin progressservicestofinishbeforereloadingapackage. Thisservicewillthrowanexceptionifthefilenamedinpackagedoesnotexistor cannototherwisebereloaded. StringMessagefromserver.(Thisisthesamemessagethatisdisplayed whenyoureloadapackagewiththeIntegrationServerAdministrator.)
329
17 Packages Folder
330
18
PKI Folder
YouusetheelementsinthepkifoldertocreateandverifyPKCS#7signatureswithPKI profiles.YoualsouseelementsinthisfoldertocreateandprocessS/MIMEmessages usingPKIprofiles.
331
18 PKI Folder

Thefollowingelementsareavailableinthisfolder: Element pub.pki.pkcs7:sign pub.pki.pkcs7:verify Package and Description WmPKI.CreatesaPKCS7SignedDataobject usingaPKIprofile. WmPKI.Processesadigitalsignatureto makesurethattheprovideddatahasnot beenmodified. WmPKI.DigitallysignsaMIMEmessage andthenencryptsit. WmPKI.DigitallysignsaMIMEmessage usingaspecifiedPKIprofile. WmPKI.DecryptsanencryptedS/MIME messageusingaspecifiedPKIprofile. WmPKI.Verifiesthesignaturefromasigned S/MIMEentityusingaspecifiedPKIprofile, andthenextractsthemessagefromthe S/MIMEentity.
pub.pki.smime.createSignedAndEncryptedData pub.pki.smime.createSignedData pub.pki.smime:processEncryptedData pub.pki.smime:processSignedData
pub.pki.pkcs7:sign
WmPKI.CreatesaPKCS7SignedDataobjectusingaPKIprofile. Thisserviceenablesmultipleentitiestosignthespecifieddata.EachsignerInfoblock containedintheresultingsignaturecontainstwoauthenticatedattributes:thecontent typeandatimestamp. Note: Thisserviceissimilartopub.security.pkcs7:signexceptthatitusesaPKIprofileto createthePKCS7SignedDataobject.
332
18 PKI Folder
Input Parameters signerInfo Document ListInformationaboutasinglesignerofthesigneddata object. Note: ThisserviceacceptsonlyonesignerInfo. Key profileAlias Description StringPKIprofilealiasusedtosignthedata. Thisserviceretrievesthekeyfromtheprofileto performthesigningoperationandincludesthe associatedpublicandCAcertificatesinthe signaturethatitgenerates. StringOptional.Thealgorithmtousewhen computingthedigestoftheprovideddata (SHA1orMD5).ThedefaultvalueisSHA-1.
hashAlgorithm
data detachedSignature
byte[ ]Datatobedigitallysigned. StringFlagspecifyingwhethertogenerateadetachedsignature.A detachedsignaturedoesnotincludethedatathatwassigned. Set to...

true false
To... Generateadetachedsignature. Default.Generateanimplicitsignature(onethat includesthesigneddata).
Output Parameters signature byte[ ]Signaturegeneratedfromthesupplieddata.ThisisaDER encodedrepresentationoftheSignedDataobjectasspecifiedin PKCS#7.
pub.pki.pkcs7:verify
WmPKI.Processesadigitalsignaturetomakesurethattheprovideddatahasnotbeen modified. Note: Thisserviceissimilartopub.security.pkcs7:verifyexceptthatitusesaPKIprofileto obtainthecertificateagainstwhichtoverifythesignerssignature.
333
18 PKI Folder
Input Parameters profileAlias signature StringNameofthePKIprofiletobeusedforcertificate verification. byte[ ]Signaturetousetodeterminewhetherthesigneddatais intact(aDERencodedrepresentationoftheSignedDataobjectas specifiedinPKCS#7).Ifyouareprocessingadetachedsignature, passthesignatureinsignature.Ifyouareprocessinganimplicit signature,passtheentiresignedentityinsignature. byte[ ]Optional.Thedatathatwassigned.Ifyouareprocessingan implicitlysignedmessage,youdonotneedtosupplydatabecause boththedataandthesignatureresideinsignature. StringFlagindicatingwhetherthemessagehasadetached signature. Key
true false
data
detachedSignature
Description Themessagehasadetachedsignature. Default.Themessagehasanimplicitsignature.
signerCertChain
byte[ ][ ] Optional.Certificatechainsofthepartiesthatsignedthe message. Note: Ifthesignersincludedthecertificatechainwiththedigital signature,youdonotneedtosupplysignerCertChain.
Output Parameters content byte[ ]Conditional.Thedata(forexample,thedocumentthatwas originallysigned)extractedfromanimplicitsignature.Ifyouare verifyingadetachedsignature,contentisnotreturned. Note: Theextracteddataisreturnedincontentevenifsignature verificationfails. signerInfo Document ListInformationaboutthesigners.Eachdocumentinthe listprovidesthefollowinginformationaboutasinglesigner: Key certChain Description java.security.cert.X509Certificate[ ] Certificatechainofthe signer.Thechainwillappearinhierarchicalorder, startingwiththesignersX.509certificateinelement0. java.util.Date Timeatwhichthesignersignedthedata.
timeStamp
334
18 PKI Folder
trusted
StringFlagindicatingwhetherthecertificatechain presentedbythesigneristrusted. A value of...

true false
Indicates that... Thechainistrusted. Thechainisnottrusted.
status
String Codeindicatingwhetherthesignatureswere successfullyverified.Ifsuccessful,statuscontains verified.Ifthesignatureswerenotsuccessfully verified,statuscontainsanerrormessage.
errorMessage
StringConditional.Ifthesignatureswerenotsuccessfullyverified, thisparametercontainsthetextInvalid signer certificate file information.
pub.pki.smime.createSignedAndEncryptedData
WmPKI.DigitallysignsaMIMEmessageandthenencryptsit. Note: Thisserviceissimilartopub.smime:createSignedAndEncryptedDataexceptthataPKI profileisusedtoprovidesigningkeyandcertificateinformation. Input Parameters envStream java.io.InputStream TheMIMEmessagethatyouwanttosignand encrypt(forexample,theoutputproducedby pub.mime:getEnvelopeStream). StringPKIprofilealiastousetosignthedata.Thisserviceretrieves thekeyfromtheprofiletoperformthesigningoperationand includestheassociatedpublicandCAcertificatesinthesignature thatitgenerates. StringOptional.Flagindicatingwhetheranimplicitorexplicit signatureistobegenerated. Set to...
true false
profileAlias
explicit
To... Default.Generateanexplicit(detached)signature. Generateanimplicitsignature.
335
18 PKI Folder
recipientCerts
byte[ ][ ] X.509certificatesoftherecipientsforwhomthismessage willbeencrypted.Eachelementinthelistcontainsthecertificatefor asinglerecipient,intheformofabytearray. Note: Formultiplerecipients,thisservicecreatesasinglemessage thatisencryptedforallrecipients.Itdoesnotcreateaseparate messageforeachrecipient.
encryptionAlg
StringOptional.Codespecifyingtheencryptionalgorithmtouse. Mustbeoneofthefollowingvalues:
TripleDES DES RC2
DefaultisTripleDES keyLength StringOptional.LengthoftheencryptionkeyforRC2encryption. Mustbeoneofthefollowingvalues:

40 64 128
Defaultis128.ThisparameterisignoredifencryptionAlgisnotRC2. Output Parameters SMimeEnvStream java.io.InputStream SignedandencryptedMIMEmessage.
pub.pki.smime.createSignedData
WmPKI.DigitallysignsaMIMEmessageusingaspecifiedPKIprofile. Note: Thisserviceissimilartopub.smime:createSignedDataexceptthataPKIprofile suppliessigningkeyandcertificateinformation. Input Parameters envStream profileAlias java.io.InputStreamMIMEmessagethatyouwanttosign(for example,theoutputproducedbypub.mime:getEnvelopeStream). StringPKIprofilealiastousetosignthemessage.Thisservice retrievesthekeyfromtheprofiletoperformthesigningoperation andincludestheassociatedpublicandCAcertificatesinthe signaturethatitgenerates.
336
18 PKI Folder
explicit
StringOptional.Flagindicatingwhetheranimplicitorexplicit signatureistobegenerated. Set to...

true false
Output Parameters SMimeEnvStream java.io.InputStreamSignedMIMEmessage.
pub.pki.smime:processEncryptedData
WmPKI.DecryptsanencryptedS/MIMEmessageusingaspecifiedPKIprofile. Note: Thisserviceissimilartopub.smime:processEncryptedDataexceptthataPKIprofile suppliessigningkeyandcertificateinformation. Input Parameters SMimeEnvStream profileAlias java.io.InputStreamTheencryptedS/MIMEentity(forexample,the outputproducedbypub.smime:createEncryptedData). StringPKIprofiletousetodecryptthemessage.Thisservice retrievesthedecryptionkeyandpublicencryptioncertificatefrom theprofiletoperformthedecryptionoperation.
Output Parameters mimeData contentDigest Document MIMEobjectcontainingthedecryptedMIMEmessage. StringMessagedigestoftheencryptedcontent,base64encoded. (Somesitesreturnthisdigesttothesendertoacknowledgetheir receiptofthemessage.) String Conditional.FlagindicatingwhetherthedecryptedMIME entityisencrypted. A value of...
true false
encrypted
Indicates that... TheMIMEentityisencrypted. TheMIMEentityisnotencrypted.
337
18 PKI Folder
signed
StringConditional.FlagindicatingwhetherthedecryptedMIME entityissigned. A value of...

true false
Indicates that... TheMIMEentityissigned. TheMIMEentityisnotsigned.
certsOnly
StringConditional.FlagindicatingwhetherthedecryptedMIME entityisacertsonlyentity. A value of...

true false
Indicates that... TheMIMEentityisacertsonlyentity. TheMIMEentityisnotacertsonlyentity.
stream
java.io.InputStreamConditional.ThedecryptedMIMEentity.This parameterispresentonlywhenthedecryptedentityisanS/MIME message.
pub.pki.smime:processSignedData
WmPKI.VerifiesthesignaturefromasignedS/MIMEentityusingaspecifiedPKI profile,andthenextractsthemessagefromtheS/MIMEentity. Note: Thisserviceislikepub.smime:processSignedDataexceptthataPKIprofilesupplies thecertificatesagainstwhichthesignatureisverified. Input Parameters SMimeEnvStream profileAlias signerCertChain java.io.InputStreamSignedMIMEentity(forexample,theoutput producedbypub.pki.smime.createSignedData). StringPKIprofiletouseforcertificatevalidation. byte[ ][ ] Optional.Certificatechainofthepartythatsignedthe message.Certificatesmustappearinhierarchicalorder,starting withthesignerscertificateinelement0. Thefollowingshowshowtheelementsofacompletechainwould appearforacertificatethatwasissuedthroughtwointermediate CAs. Element 0 1 Contents Signerscertificate IntermediaryCACertificate
338
18 PKI Folder
2 3
IntermediaryCACertificate RootCACertificate
Note: Ifthesignerincludedthecertificatechainwiththedigital signature,youdonotneedtosupplysignerCertChain. Output Parameters mimeData contentDigest signerCert encrypted DocumentMIMEobjectcontainingtheextractedMIMEentity. StringMessagedigest(base64encoded)thatprocessSignedData recalculated. java.security.cert.X509Certificate SignersX509certificate. StringConditional.FlagindicatingwhethertheextractedMIME entityisencrypted. A value of...
true false
signed
StringConditional.FlagindicatingwhethertheextractedMIME entityissigned. A value of...

true false
certsOnly
StringConditional.FlagindicatingwhethertheextractedMIME entityisacertsonlyentity. A value of...

true false
stream
java.io.InputStreamConditional.ExtractedMIMEentity.This parameterispresentonlywhenthedecryptedentityisanS/MIME message.
339
18 PKI Folder
verify
StringFlagindicatingwhetherthesignaturewassuccessfully processed(thatis,thesignaturewassuccessfullyverifiedwiththe publickeysuppliedbythePKIprofile). A value of...

true false
Indicates that... Signatureprocessingwassuccessful. Signatureprocessingfailed.Thesignaturecouldnot beverifiedbecauseerrorCode1or4occurred(see errorCodebelow).
trusted
StringThesignerisatrustedentity.Forthesignertobetrusted,the signerscertificateoroneofitsrootcertificatesshouldbepresentin thetrustedCAdirectory. A value of...

true false
Indicates that... Thesignerisatrustedentity. Thesignerisnotatrustedentity.
errorCode
StringConditional.Numberindicatingwhatkindoferroroccurred, ifany,whileprocessingthesignature.SeeerrorMessageforpossible values. Ifnoerroroccurred,errorCodeisnotreturned. StringConditional.Textualerrormessageindicatingwhatkindof erroroccurred,ifany,whileprocessingthesignature. errorCode

1 4 5 6 7
errorMessage
errorMessage
Invalid signer certificate chain file information. Signature cannot be verified. Expired certificate chain. Error in certificate chain. Untrusted certificate.
Usage Notes Ifverifyisfalse,theerrorCodeanderrorMessagevalueswillindicatetheerrorthat causedthefailure.NotethaterrorCodevalues5through7donotrepresentsignature verificationfailures,andthereforedonotcausetheverifyflagtobesettofalse. Iftheextractedentityissignedorencrypted,mimeDatawillbeemptyandthe extractedentitywillresideinstream.Youcancheckthestateofthesignedand
340
18 PKI Folder
encryptedoutputvariablestodeterminewhethertheextractedentityrequires additionalprocessing,thenpassstreamtotheprocessEncryptedDataserviceasnecessary. See Also pub.smime:processEncryptedData pub.smime:createSignedData
341
18 PKI Folder
342
19
Publish Folder
YouusetheelementsinthepublishfoldertopublishdocumentstootherIntegration ServersviawebMethodsBroker.
343
19 Publish Folder

Thefollowingelementsareavailableinthisfolder: Element pub.publish:deliver pub.publish:deliverAndWait Package and Description WmPublic.Deliversadocumenttoaspecificdestination. WmPublic.Requestsareplydocumentfromaspecific client.Theservicewaitsforthereplyorindicatesthatthe pub.publish:waitForReplyserviceshouldretrievethereply later. WmPublic.Specificationforthesignatureofaservice thatdetermineswhetheradocumentsstatusisNew, Duplicate,orInDoubt. WmPublic.Documenttypethatdefinesthecontentand structureoftheenvelopethataccompaniesapublished document. WmPublic.Retrievestheredeliverycountfora document. WmPublic.Publishesadocumentlocallyortothe Broker. WmPublic.Broadcastsarequestforadocumentfrom anyclientsubscribedtoaspecificdocumenttype.The servicewaitsforthereplyorindicatesthatthe pub.publish:waitForReplyserviceshouldretrievethereply later. WmPublic.Deliversareplydocumenttotherequesting client. WmPublic.Retrievesthereplyforanasynchronous request.Ifareplyisnotavailable,theIntegrationServer continuestowaitforthedocumentuntilthetime specifiedinthewaitTimeparameterofthe pub.publish:deliverAndWaitorpub.publish:publishAndWaitservice elapses. WmPublic.Publishabledocumenttypethatdefinesthe documentthattheIntegrationServergeneratesand deliverswhenatriggerencountersanerrororexception conditionduringprocessing.
pub.publish:documentResolverS pec pub.publish:envelope
pub.publish:getRedeliveryCount pub.publish:publish pub.publish:publishAndWait
pub.publish:reply pub.publish:waitForReply
pub.publish.notification:error
344
19 Publish Folder
pub.publish:deliver
WmPublic.Deliversadocumenttoaspecificdestination. Note: YoumustbeconnectedtoaBrokertousethisservice. Input Parameters documentTypeName StringFullyqualifiednameofthepublishabledocumenttype beingdelivered. Thepublishabledocumenttypemustbesynchronizedwith theassociatedBrokerdocumenttype.Ifthedocumenttypes arenotsynchronized,publicationfails. document destId DocumentDocument(IDataobject)conformingtothe publishabledocumenttypeindocumentTypeName. StringTheclientIDtowhichthedocumentwillbedelivered. YoucanspecifythedefaultclientIDforanIntegration Server,oryoucanspecifytheclientIDforanindividual trigger.IfyouspecifyanincorrectclientID,theIntegration ServerdeliversthedocumenttotheBroker,buttheBroker neverdeliversthedocumenttotheintendedrecipientand noerrorisproduced. StringOptional.FlagindicatingwhethertheIntegration Servershouldpublishthedocumentwhenthe pub.publish:deliverserviceexecutesorafterthetoplevelservice successfullycompletes.Ifthetoplevelservicefails,the IntegrationServerwillnotpublishthedocument. Set to...
true
delayUntilServiceSuccess
To... Delaypublishinguntilafterthetoplevelservice executessuccessfully. Default.Publishthedocumentwhenthe pub.publish:deliverserviceexecutes.
false
Output Parameters None. Usage Notes ToviewalistofclientIDsontheBroker,usetheBrokeruserinterfacewithinMy webMethodsoruseDevelopertotestthepublishabledocumenttypethatyouwantto deliver.
345
19 Publish Folder
FormoreinformationabouthowtheIntegrationServerandBrokerdeliver documentsandforinformationaboutbuildingaservicethatdeliversadocument,see thePublishSubscribeDevelopersGuide. Ifoutboundclientsidequeuingisdisabled(thewatt.server.publish.useCSQ propertyissettonever),IntegrationServerthrowsaServiceExceptioniftheBroker isnotavailablewhenthisserviceexecutes.Makesuretocodeyourservicetohandle thissituation. See Also pub.publish:publish pub.publish:deliverAndWait pub.publish:envelope
pub.publish:deliverAndWait
WmPublic.Requestsareplydocumentfromaspecificclient.Theservicewaitsforthe replyorindicatesthatthepub.publish:waitForReplyserviceshouldretrievethereplylater. Note: YoumustbeconnectedtoaBrokertousethisservice. Input Parameters documentTypeName StringFullyqualifiednameofthepublishabledocument typebeingdelivered. Note: Thepublishabledocumenttypemustbe synchronizedwiththeassociatedBrokerdocumenttype. Ifthedocumenttypesarenotsynchronized,publication fails. document receiveDocumentTypeName DocumentDocument(IDataobject)conformingtothe publishabledocumenttypeindocumentTypeName. StringOptional.Fullyqualifiednameofthepublishable documenttypeexpectedasareply.Ifnovalueis specified,theserviceusesthefirstreplydocumentofany typeitreceives,aslongasthevalueoftagintheenvelope ofthereplydocumentmatchesthetagintheenvelopeof thepublisheddocument.Allotherreplydocumentsare discarded.
346
19 Publish Folder
destId
StringTheclientIDtowhichthedocumentwillbe delivered.YoucanspecifythedefaultclientIDforan IntegrationServer,oryoucanspecifytheclientIDforan individualtrigger.IfyouspecifyanincorrectclientID, theIntegrationServerdeliversthedocumenttothe Broker,buttheBrokerneverdeliversthedocumentto theintendedrecipientandnoerrorisproduced. StringOptional.Specifiesthetimetowait(in milliseconds)fortheresponsetoarrive.Ifnovalueis specified,theservicewaitsindefinitelyuntilitreceivesa reply. StringOptional.Flagspecifyingwhetherthisisan asynchronousorsynchronousrequest/reply. Set to...
true
waitTime
async
To... Indicatethatthisisanasynchronous request/reply.Afterpublishingthedocument, theIntegrationServerexecutesthenextstep intheflowserviceimmediately.The IntegrationServerdoesnotwaitforareply beforecontinuingserviceexecution. Note: Toretrievethereplytoanasynchronous request,invokethepub.publish:waitForReply service.
false
Default.Indicatethatthisisasynchronous request/reply.Afterpublishingthedocument, theIntegrationServerwaitsforareplybefore executingthenextstepintheflowservice.
347
19 Publish Folder
Output Parameters receivedDocument DocumentADocument(IDataobject)receivedasreply. Important! TheIntegrationServertreatsallreply documentsasvolatiledocuments.IftheIntegration Servershutsdownbeforeprocessingthereply document,thereplydocumentislost. tag StringConditional.Auniqueidentifierforadeliver request.TheIntegrationServerusesthetagvalueto matchtherequestingdocumentwithitscorresponding replydocument. Theserviceproducesatagoutputvalueonlywhenthe asyncfieldissettotrue.Thetagvalueisrequiredinput whenusingthepub.publish:waitForReplyservicetoretrieve thereply. Note: Thetagoutputvalueisthesamevaluethatthe IntegrationServerplacesinthetagfieldoftherequest documentsenvelope. Usage Notes Youcanusethepub.publish:deliverAndWaitservicetoinitiateandcontinueaprivate conversationbetweentwoBrokerclients.Thisisavariationoftherequest/replymodel. Oneclientexecutesaservicethatdeliversadocumenttoaspecificclient.This documentrequestsinformationfromthereceivingclient. Inasynchronousrequest/reply,thedeliveringservicestopsexecutingwhileit waitsforaresponse.Whentheservicereceivesareplydocumentfromthe specifiedclient,theserversresumesexecuting.IfthewaitTimeelapsesbeforethe servicereceivesareply,theIntegrationServerendstherequest,andtheservice returnsanulldocumentindicatingthattherequesttimedout.TheIntegration Serverthenexecutesthenextstepintheflowservice.Ifareplydocumentarrives aftertheflowserviceresumesexecution,theIntegrationServerrejectsthe documentandcreatesajournallogmessagestatingthatthedocumentwas rejectedbecausethereisnoservicethreadwaitingforthedocument. Inanasynchronousrequest/reply,thedeliveringservicecontinuesexecutingthe stepsintheserviceafterpublishingthedocument.Toretrievethereply,the deliveringservicemustinvokethepub.publish:waitForReplyservice.Ifthewaittime elapsesbeforethepub.publish:waitForReplyservicereceivesadocument,the pub.publish:waitForReplyservicereturnsanulldocumentindicatingthattherequest timedout. Aservicethatcontainsmultipleasynchronousdeliverrequestsallowstheserviceto deliveralltherequestsbeforecollectingthereplies.Thisapproachcanbemore
348
19 Publish Folder
efficientthandeliveringarequest,waitingforareply,andthendeliveringthenext request. Ifyoucreateaservicethatcontainsmultipleasynchronousrequests,makesureto linkthetagoutputtoanotherfieldinthepipeline.Eachasynchronousdelivery producesatagfieldinthepipeline.Ifthetagfieldisnotlinkedtoanotherfield,the nextasynchronousdeliveryrequest(thatis,thenextexecutionofthe pub.publish:deliverAndWaitservice)willoverwritethefirsttagvalue. ToviewalistofclientIDsontheBroker,usetheBrokeruserinterfaceoruse Developertotestthepublishabledocumenttypethatyouwanttodeliver. Usepub.publish:deliverAndWaitifyouneedtoknowthataspecificclientsuccessfully receivedandprocessedtherequestdocument. Formoreinformationabouthowtobuildaservicesthatinitiatesynchronousor asynchronousrequest/replyscenarios,seethePublishSubscribeDevelopersGuide. Ifoutboundclientsidequeuingisdisabled(thewatt.server.publish.useCSQ propertyissettonever),IntegrationServerthrowsaServiceExceptioniftheBroker isnotavailablewhenthisserviceexecutes.Makesuretocodeyourservicetohandle thissituation. See Also pub.publish:waitForReply pub.publish:publishAndWait pub.publish:reply pub.publish:envelope
pub.publish:documentResolverSpec
WmPublic.Specificationforthesignatureofaservicethatdetermineswhethera documentsstatusisNew,Duplicate,orInDoubt. Input Parameters documentTypeName redeliveryCount uuid document StringFullyqualifiednameofthedocumentwhosestatusisIn Doubt. StringNumberoftimesthedocumenthasbeenredeliveredto thetriggerqueueontheIntegrationServer. StringUniversallyuniqueidentifierforthedocument.The publishingapplicationassignstheuuidtoadocument. DocumentThedocument(IDataobject)whosestatusneedstobe resolved.Thisdocumentmustconformtothepublishable documenttypespecifiedindocumentTypeName.
349
19 Publish Folder
transport triggerName Output Parameters status
String Thetransport(suchasLOCALorBROKER)usedtosend thedocumenttotheIntegrationServer. StringThenameoftheBroker/localtriggerthatreceivedthe documentwhosestatusneedstoberesolved.
StringIndicatesthestatusofthedocument.Thevalueofthisfield determineswhethertheIntegrationServerprocessesthedocument, discardsthedocument,orsendsthedocumenttotheauditlog.The statusfieldmusthaveoneofthefollowingvalues. Key

NEW
Description Indicatesthedocumentisnewandhasnotbeen processedbythetrigger.IntegrationServerinstructs thetriggertoprocessthedocument. Indicatesthedocumentisaduplicateofonealready processedbythetrigger.IntegrationServerdiscardsthe documentandgeneratesajournallogmessage. Indicatesthestatusofthedocumentisstillindoubt. Thedocumentresolverservicecouldnotconclusively determinewhetherthetriggeralreadyprocessedthe document.Iftheauditlogisadatabase,theaudit subsystemlogsthedocumentandtheIntegration Servergeneratesajournallogmessage.
DUPLICATE
IN_DOUBT
message
StringConditional.Auserspecifiedstringthatindicateswhythe documentstatusisDUPLICATEorIN_DOUBT.IntegrationServerwritesthe messagetothejournallogwhentheserverdiscardsthedocumentor routesittotheauditlog.
Usage Notes Thepub.publish:documentResolverSpecmustbeusedasthesignatureforanyserviceused toresolvetheprocessingstatusofadocument.Forinformationaboutbuildinga documentresolverserviceandenablingexactlyonceprocessingforaBroker/local trigger,seethePublishSubscribeDevelopersGuide. Usethepub.jms:documentResolverSpecasthesignatureforadocumentresolverservice usedtodeterminethestatusofaJMSmessagereceivedbyaJMStrigger. See Also pub.jms:documentResolverSpec
350
19 Publish Folder
pub.publish:envelope
WmPublic.Documenttypethatdefinesthecontentandstructureoftheenvelopethat accompaniesapublisheddocument. Theenveloperecordsinformationsuchasthesendersaddress,thetimethedocument wassent,passwordandcertificateinformation,andotherusefulinformationforrouting andcontrol.Everypublishabledocumenttypecontainsadocumentreferencetothis documenttype. Read/Write Parameters Youcansetthefollowingparameterswithinyourservice. activation StringOptional.AuniqueidentifierthatanyBrokerclient(including theIntegrationServer)assignstoalldocumentspublishedasa resultoftheonetimeexecutionoftheintegrationsolution.Ifa documentdoesnothaveanactivationID,theIntegrationServer assignsonewhenthedocumentispublished. Ifyouareusingatriggertojoindocumentspublishedbydifferent services,youmustexplicitlysettheactivationIDofthedocuments. Theservicesthatpublishthedocumentsmustassignthesame activationIDtothedocuments. appLastSeqn appPassword java.lang.Integer Optional.Thisfieldisprovidedforbackward compatibility. StringOptional.ThepasswordoftheuserspecifiedinappUserName. Iftheresourcethatprocessesthedocumentrequiresauthentication beforeitbeginsprocessing,specifythepasswordinthisfield. java.lang.IntegerOptional.Thisfieldisprovidedforbackward compatibility. StringOptional.Theusernameforloggingintotheapplicationthat processesthedocument.UsetheappPasswordfieldtospecifythe passwordforthisusername. StringOptional.UsedbytheIntegrationServertotrackbusiness processcontextandauditcontextacrossmultipleIntegration Servers. Important! ThebusinessContextfieldisreservedforinternalusebythe webMethodsIntegrationServer.Donotsetoroverwritethevalueof thebusinessContextfield. controlLabel java.lang.Short[ ]Optional.Thisfieldisprovidedforbackward compatibility.
appSeqn appUserName
businessContext
351
19 Publish Folder
errorsTo
StringOptional.TheclientIDtowhichtheIntegrationServersends anerrornotificationdocumentiferrorsoccurduringdocument processingbysubscribers.Ifthisparameterisnotset,error notificationswillbesenttothedocumentpublisher.Theerrors documentisaninstanceofpub.publish.notification:error. StringOptional.Thisfieldisprovidedforbackwardcompatibility. StringOptional.LocaleofthepublishingclientexpressedasaURN (UniformResourceName).Triggerservicesexaminethelocalevalue todeterminethelocaletousewhenprocessingthedocument.Ifthe localefieldisempty,thelocaleofthecurrentIntegrationServeris usedinstead. java.lang.Integer Optional.Thisfieldisprovidedforbackward compatibility. StringOptional.TheclientIDtowhichtherepliestothepublished documentshouldbesent.Ifthisparameterisnotset,replieswillbe senttothedocumentpublisherasspecifiedinpubId. java.lang.IntegerOptional.Thisfieldisprovidedforbackward compatibility. byte[ ] Optional.Abytesequencethatholdsadigitalsignature. Specifyadigitalsignatureifclientsreceivingthisdocument requiresone. String Optional.Thetypeofdigitalsignaturebeingused. java.lang.IntegerOptional.Thisfieldisprovidedforbackward compatibility. java.lang.IntegerOptional.Usedwithpub.publish:publishAndWaitand pub.publish:deliverAndWaittomatcharequestdocumentwithits correspondingreplydocument. Important! Thetagfieldisreservedforinternalusebythe webMethodsIntegrationServer.Donotsetoroverwritethevalueof thetagfieldintheenvelope.
errorRequestsTo locale
maxResults replyTo
runLevel signature
signatureType startResult tag
trackId
StringOptional.Auniqueidentifierassignedtoapublished documentbythepublishingclientapplication.Ifnovalueis specified,IntegrationServerpopulatesthisfieldwiththevalueof theuuidfield. StringOptional.Thisfieldisprovidedforbackwardscompatibility. StringOptional.Anindicationofadocumentscurrentstate,setbya publishingclientapplicationthattransformsdata.Forexample,a clientcouldpublishadocumentwithatransformStatevalueof USEnglishandareceivingclientcouldtranslatethedocument intoFrenchandpublishitwithatransformStatevalueofFrench.
transactionId transformState
352
19 Publish Folder
Read-only Parameters TheBrokerorIntegrationServersetthefollowingparameters.Youcannotsetthese parameterswithinyourservice,butyoucanretrievetheirvalues.M age java.lang.IntegerOptional.Thecumulativetime,inseconds, thatthedocumentspendsonallBrokers.TheBrokerstarts trackingthedocumentagewhenitreceivesthedocument fromthepublishingclient.TheBrokerstopstrackingthe documentagewhenthesubscribingclientremovesthe documentfromtheclientqueue.Ifthedocumentisroutedto successiveBrokers,agealsoincludesthelengthoftimethe documentspendsontheotherBrokers. StringOptional.Anindicationofwhetherthereceived documentpassedoveralinkthatisnotsecure.Thisfieldcan haveoneofthefollowingvalues: Key <empty> Description Atsomepoint,thedocumentpassed throughaconnectionthatwasnot encrypted. Alltheconnectionsusedtotransportthe eventhadanencryptionstrengthof ENCRYPT_LEVEL_US_EXPORTorgreater. Theeventtraveledexclusivelyover connectionswithanencryptionstrengthof ENCRYPT_LEVEL_US_DOMESTIC.
connectionIntegrity
U.SExport
U.S.Domestic
destId
StringOptional.TheIDoftheclienttowhichthedocumentis beingdelivered.ThepublishingclientsetsthedestIDwhenit publishesthedocument.Forexample,theIntegrationServer usesthedestIDvaluespecifiedinthepub.publish:deliverservice orthepub.publish:deliverAndWaitservicetopopulatethedestID valueinthedocumentenvelope java.util.DateOptional.ThedateandtimethattheBroker placedthedocumentintotheclientqueue. StringOptional.ThenameoftheBrokerthatcontainsthe documentinitsdocumentlog.TheBrokersetsthis parameterwhenBrokerbaseddocumentloggingandthe loggingutilityareenabled. StringOptional.Thehostnameandportnumberofthe Brokerthatcontainsthedocumentinitsdocumentlog.The BrokersetsthisparameterwhenBrokerbaseddocument loggingandtheloggingutilityareenabled.
enqueueTime logBroker
logHost
353
19 Publish Folder
pubDistinguishedName
StringOptional.Thedistinguishednameofthepublishers SSLcertificate.TheBrokersetsthisparameterwhenthe publisherhasanSSLconnectiontotheBrokerandclearsthis parameterwhenthepublisherhasanonSSLconnection. StringOptional.TheclientIDofthedocumentspublisher.If thepublishingclientisconnectedtoadifferentBrokerthan therecipient,theBrokerusesthefullyqualifiedclientID (thatis,theBrokerprefixestheclientIDwiththenameofthe publishersBroker).YoucanusetheIntegrationServer AdministratortoviewtheclientIDforanIntegrationServer. YoucanusetheBrokeruserinterfaceonMywebMethodsto viewtheclientIDsforallclientsconnectedtoaBroker. byte[ ] Optional.TheIPaddressandportnumberofthe documentspublisher. java.lang.LongOptional.Thisfieldisprovidedforbackwards compatibility. java.lang.Short[ ] Optional.Thisfieldisprovidedfor backwardscompatibility. java.util.Date Optional.Thedateandtimethedocumentwas receivedbytheBroker. Document ListOptional.InformationabouttheBrokers throughwhichadocumentpassed.WhenaBrokerreceives adocument,theBrokersetsthebrokerandrecvTimekeys. WhentheBrokerplacesthedocumentinthequeueforthe nextBroker,thefirstBrokersetsenqueueTime.TheBroker onlysetsthesefieldswhendocumentisforwardedfromone Brokertoanother.TheBrokerdoesnotsetthesefieldswhen thepublishingandreceivingclientsareconnectedtothe sameBroker. Key broker recvTime Description StringOptional.ThenameoftheBroker. java.util.Date Optional.ThetimetheBroker receivedthedocumentfromthepublishing clientoranotherBroker. java.util.DateOptional.ThetimetheBroker placedthedocumentinthequeueforthe nextBroker.
pubId
pubNetAddr pubSeqn pubLabel recvTime route
enqueueTime
uuid
StringOptional.Universallyuniqueidentifierforthe document.TheIntegrationServerassignstheUUIDwhenit publishesthedocument.ThereceivingIntegrationServer usestheUUIDtodetectduplicatedocuments.
354
19 Publish Folder
Output Parameters None. Usage Notes Formoreinformationaboutsettingandusingadocumentsenvelopeparameters,see thewebMethodsBrokerClientJavaAPIReferenceGuide,thewebMethodsBrokerClientC APIProgrammersGuide,PublishSubscribeDevelopersGuide,andthewebMethods DeveloperUsersGuide. See Also pub.publish:deliver pub.publish:deliverAndWait pub.publish:publish pub.publish:publishAndWait pub.publish:publishAndWait pub.publish.notification:error
pub.publish:getRedeliveryCount
WmPublic.Retrievestheredeliverycountforadocument. Theredeliverycountindicatesthenumberoftimesthedocumenthasbeenredeliveredto thetriggerqueueontheIntegrationServer.Adocumentisredeliveredtoatriggerqueue iftheIntegrationServershutsdownbeforeprocessingandacknowledgingthedocument. Input Parameters None. Output Parameters redeliveryCount StringSpecifiesthenumberoftimesthetriggerqueueonthe IntegrationServerhasreceivedthedocument.Theredeliverycount canbeoneofthefollowing: Value
-1
Description Indicatesthetransportusedtosendthedocumentdoes notmaintainadocumentredeliverycount.Forexample,a documentreceivedfromaBrokerversion6.0.1hasa redeliverycountof1.(Brokersthatareversion6.0.1or earlierdonotmaintaindocumentredeliverycounts.) TheIntegrationServerdocumentmayormaynothave receivedthedocumentbefore.
355
19 Publish Folder
0 > 0
Indicatesthedocumenthasbeenreceivedonlyonce. Indicatesthenumberoftimesdocumenthasbeen redelivered.
Usage Notes IfyoudonotwanttousetheexactlyonceprocessingcapabilitiesDeveloperprovides, youcaninvokethepub.publish:getRedeliveryCount servicewithinyourtriggerservice.The redeliverycountforadocumentcanprovideaninitialindicationofwhetherthe IntegrationServerhasalreadyprocessedthedocument. TheIntegrationServerretrievestheredeliverycountforthedocumentcurrently maintainedintheinvokestate.Thatis,theIntegrationServerretrievestheredelivery countforthedocumentthatcausedthetriggerservicetoexecute. WhenatriggerservicesatisfiedbyanAll (AND)joinconditioninvokes pub.publish:getRedliveryCount,thepub.publish:getRedeliveryCountservicereturnsthe redeliverycountforthelastdocumentreceivedbythejoin.Forexample,supposethat documentsAandBsatisfiedanAll (AND)joincondition.IftheIntegrationServer receivesdocumentAfirstanddocumentBsecond,whenpub.publish:getRedliveryCount executes,itretrievestheredeliverycountfordocumentB.
pub.publish:publish
WmPublic.PublishesadocumentlocallyortotheBroker. Thisservicebroadcaststhedocument(thatis,distributesthedocumenttoallclientsthat subscribetoit). Input Parameters documentTypeName StringFullyqualifiednameofthepublishabledocumenttype beingpublished. IfyouintendtopublishthedocumenttotheBroker,the publishabledocumenttypemustbeinsyncwiththe associatedBrokerdocumenttype.Ifthedocumenttypesare notsynchronized,publicationfails. document local DocumentDocument(IDataobject)conformingtothe documenttypeindocumentTypeName. StringOptional.Flagspecifyingwhetherthedocumentisto bepublishedlocallyortotheBroker. Set to...
true false
To... Publishlocally(tothisIntegrationServeronly). Default.PublishtotheBrokerconnectedtothis IntegrationServer.
356
19 Publish Folder
IfnoBrokerisconfiguredfortheIntegrationServer,all publishesbecomelocal(thatis,thelocalflagissetimplicitly totrue). delayUntilServiceSuccess StringOptional.Flagindicatingwhetherthepublishshould happenwhenthepub.publish:publishserviceexecutesorafter thetoplevelservicesuccessfullycompletes.Ifthetoplevel servicefails,theIntegrationServerwillnotpublishthe document. Set to...
true
To... Delaypublishinguntilafterthetoplevelservice executessuccessfully. Note: IntegrationServerdoesnotreturnthestatus outputparameterwhendelayUntilServiceSuccessis settotrue.
false
Default.Publishthedocumentwhenthepublish serviceexecutes.
Output Parameters status StringStatusindicatingwhethertheservicewassuccessful. IntegrationServerreportsstatusonlyforlocallypublished documents. A value of...

success
Indicates that... Theserviceexecutedsuccessfully. Note: Ifatleastonesubscribingtriggerhasroom initsqueue,thestatusissettosuccess.
noSubscriber
IntegrationServerdoesnotcontainanytriggers thatsubscribetothedocument. Thedocumentcouldnotbeplacedinthequeue ofthesubscribingtriggerbecausethetrigger queueiscurrentlyatitsmaximumcapacity. Note: IntegrationServerreportsthisstatusonly whenthewatt.server.publish.local.rejectOOS propertyissettotrue.
capacityExceeded
357
19 Publish Folder
Usage Notes IntegrationServerwritesamessagetothejournallogwheneveritrejectsordiscardsa document. Ifoutboundclientsidequeuingisdisabled(thewatt.server.publish.useCSQ propertyissettonever),IntegrationServerthrowsaServiceExceptioniftheBroker isnotavailablewhenthisserviceexecutes.Makesuretocodeyourservicetohandle thissituation. Formoreinformationaboutbuildingaservicethatpublishesadocumentlocallyorto theBroker,seethePublishSubscribeDevelopersGuide. See Also pub.publish:deliver pub.publish:publishAndWait pub.publish:envelope
pub.publish:publishAndWait
WmPublic.Broadcastsarequestforadocumentfromanyclientsubscribedtoaspecific documenttype.Theservicewaitsforthereplyorindicatesthatthepub.publish:waitForReply serviceshouldretrievethereplylater. Input Parameters documentTypeName StringFullyqualifiednameofthepublishabledocument typebeingpublished. IfyouintendtopublishthedocumenttotheBroker,the publishabledocumenttypemustbeinsyncwiththe associatedBrokerdocumenttype.Ifthedocumenttypes arenotsynchronized,publicationfails. document receiveDocumentTypeName DocumentDocument(IDataobject)conformingtothe documenttypeindocumentTypeName. StringOptional.Fullyqualifiednameofthedocument typeexpectedasareply.Ifnovalueisspecified,the serviceusesthefirstreplydocumentofanytypeit receives,aslongasthevalueoftaginthereplydocument envelopematchesthetagintheenvelopeofthe publisheddocument.Allotherreplydocumentsare discarded.
358
19 Publish Folder
local
StringOptional.Flagspecifyingwhetherthedocumentis tobepublishedlocallyortotheBroker. Set to...

true
To... Publishlocally(tothisIntegrationServer only). Default.PublishtotheBrokerattachedtothis IntegrationServer.
false
IfnoBrokerisconfiguredfortheIntegrationServer,all publishesbecomelocal(thatis,thelocalflagisset implicitlytotrue). waitTime StringOptional.Timetowait(inmilliseconds)forthe responsetoarrive.Ifnovalueisspecified,theservice waitsindefinitelyforareply. StringOptional.Flagspecifyingwhetherthisisan asynchronousorsynchronouspublish. Set to...
true
async
To... Indicatethatthisisanasynchronous request/reply.Afterpublishingthedocument, theIntegrationServerexecutesthenextstepin theflowserviceimmediately.TheIntegration Serverdoesnotwaitforareplybefore continuingserviceexecution. Note: Toretrievethereplytoanasynchronous publish,invokethepub.publish:waitForReply service.
false
Default.Indicatethatthisisasynchronous request/reply.Afterpublishingthedocument, theIntegrationServerwaitsforareplybefore executingthenextstepintheflowservice.
Output Parameters receivedDocument DocumentDocument(IDataobject)receivedasresponse.Ifno matchingdocumentisreceivedwithinthewaittime,thiswillbe null. Important! TheIntegrationServertreatsallreplydocumentsas volatiledocuments.IftheIntegrationServershutsdownbefore processingthereplydocument,thereplydocumentislost.
359
19 Publish Folder
tag
StringConditional.Auniqueidentifierforapublishrequest.The IntegrationServerusesthetagvaluetomatchtherequest documentwithitscorrespondingreplydocument. Theserviceproducesatagoutputvalueonlywhentheasyncfield issettotrue.Thetagvalueisrequiredinputwhenusingthe pub.publish:waitForReplyservicetoretrievethereply. Note: ThetagoutputvalueisthesamevaluethattheIntegration Serverplacesinthetagfieldoftherequestdocumentsenvelope.
status
StringStatusindicatingwhethertheservicewassuccessful. IntegrationServerreportsstatusonlyforlocallypublished documents. A value of...

success
Indicates that... Theserviceexecutedsuccessfully. Note: Ifatleastonesubscribingtriggerhas roominitsqueue,thestatusissettosuccess.
requestTimedOut
Theservicetimedout(thatis,thewaitTime specifiedintheserviceelapsedbefore IntegrationServerreceivedareply). TheIntegrationServerdoesnotcontainany triggersthatsubscribetothedocument. Thedocumentcouldnotbeplacedinthe queueofthesubscribingtriggerbecausethe triggerqueueiscurrentlyatitsmaximum capacity. Note: IntegrationServerreportsthisstatus onlywhenthe watt.server.publish.local.rejectOOSproperty issettotrue.
noSubscriber
capacityExceeded
Usage Notes IntegrationServerwritesamessagetothejournallogwheneveritrejectsordiscardsa document. Youcanusethepub.publish:publishAndWaitservicetoinitiatearequest/reply.The publishingclientbroadcastsarequestforinformation.Subscriberstothebroadcast documentcomposeandsendareplydocumentthatcontainstheinformationthe publisherrequested.
360
19 Publish Folder
Asinglepublishandwaitrequestmightreceivemanyresponsedocuments.The IntegrationServerthatmadethepublishandwaitrequestusesonlythefirstreply documentitreceivesfromtheBroker.TheIntegrationServerdiscardsallother replies.Firstisarbitrarilydefined.Thereisnoguaranteeprovidedfortheorderin whichtheBrokerprocessesincomingreplies.Ifyouneedareplydocumentfroma specificclient,usethepub.publish:deliverAndWaitserviceinstead. ThepublishAndWaitservicecanbeusefulinsituationswheremultiplesourcescontain theresponsedata.Forexample,supposethatanenterpriseusesoneapplicationfor managingcustomerdata,anotherforstoringmastercustomerrecords,anda mainframesystemforsavingcustomerlists.Eachoftheseapplicationscouldanswer apublishedrequestforcustomerdata.Thepublishingservicewillusethefirstreply documentitreceives. Aservicecanissueapublishandwaitrequestinasynchronousorasynchronous manner. Inasynchronousrequest/reply,thepublishingflowMservicestopsexecuting whileitwaitsforaresponse.Whentheservicereceivesareplydocument,the serviceresumesexecution.IfthewaitTimeelapsesbeforetheservicereceivesa reply,theIntegrationServerendstherequest,andtheservicereturnsanull documentthatindicatesthattherequesttimedout.TheIntegrationServerthen executesthenextstepintheflowservice.Ifareplydocumentarrivesafterthe flowserviceresumesexecution,theIntegrationServerrejectsthedocumentand createsajournallogmessagestatingthatthedocumentwasrejectedbecause therewasnothreadwaitingforthedocument. Inanasynchronousrequest/reply,thepublishingflowservicecontinues executingthestepsintheserviceafterpublishingthedocument.Toretrievethe reply,thepublishingflowservicemustinvokethepub.publish:waitForReplyservice.If thewaittimeelapsesbeforethepub.publish:waitForReplyservicereceivesadocument, thepub.publish:waitForReplyservicereturnsanulldocumentindicatingthatthe requesttimedout. Aservicethatcontainsmultipleasynchronouspublishandwaitinvocationsallows theservicetopublishalltherequestsbeforecollectingthereplies.Thisapproachcan bemoreefficientthanpublishingarequest,waitingforareply,andthenpublishing thenextrequest. Ifyoucreateaservicethatcontainsmultipleasynchronousrequests,makesureto linkthetagoutputtoanotherfieldinthepipeline.Eachasynchronouslypublished requestproducesatagfieldinthepipeline.Ifthetagfieldisnotlinkedtoanother field,thenextasynchronouslypublishedrequest(thatis,thenextexecutionofthe pub.publish:publishAndWaitservice)willoverwritethefirsttagvalue. Formoreinformationaboutbuildingaservicethatfollowstherequest/replymodel, seethePublishSubscribeDevelopersGuide. Ifoutboundclientsidequeuingisdisabled(thewatt.server.publish.useCSQ propertyissettonever),IntegrationServerthrowsaServiceExceptioniftheBroker isnotavailablewhenthisserviceexecutes.Makesuretocodeyourservicetohandle thissituation.
361
19 Publish Folder
See Also pub.publish:waitForReply pub.publish:reply pub.publish:envelope
pub.publish:reply
WmPublic.Deliversareplydocumenttotherequestingclient. IfthereplyToenvelopeparameterisset,thereplydocumentisdeliveredtothat destination;otherwise,thereplydocumentissenttotheclientIDofthepublisher specifiedintheenvelopespubIdfield.Thisservicealsocorrectlymapstherequiredfields fromtherequestdocumenttothereplydocument. Note: Allreplydocumentsarevolatiledocuments.IftherequestingIntegrationServer shutsdownbeforeprocessingthereplydocument,thereplydocumentislost. Input Parameters receivedDocumentEnvelope DocumentOptional.Theenvelopeofthedocumentto whichyouarereplying.Bydefault receivedDocumentEnvelopespecifiestheenvelopeofthe documentthattriggeredthisservice.(Incaseofajoin,it willspecifythelastdocumentthatsatisfiedthejoin condition.)However,youmayspecifytheenvelopeofany publisheddocumenttowhichyouwanttoreply. StringFullyqualifiednameofthepublishabledocument typeforthedocumentthatyouaresendingasareply. Keepinmindthatthepublisheroftherequesting documentmightbeexpectingareplydocumentthat conformstospecificpublishabledocumenttype. DocumentThereplyIDataobject.Thisdocumentmust conformtothepublishabledocumenttypespecifiedin documentTypeName.
documentTypeName
document
362
19 Publish Folder
delayUntilServiceSuccess
StringOptional.FlagindicatingwhethertheIntegration Servershouldpublishthedocumentwhenthe pub.publish:replyserviceexecutesorafterthetoplevelservice successfullycompletes.Ifthetoplevelservicefails,the IntegrationServerwillnotpublishthedocument. Set to...

true
To... Delaypublishinguntilafterthetoplevelservice executessuccessfully. Default.Publishthedocumentwhenthepublish serviceexecutes.
false
Output Parameters None. Usage Notes Areplydocumentcanbeasimpleacknowledgment,oritcancontaininformation askedforbythepublisheroftherequestdocument. Ifyouarebuildingaservicetoreplytodocumentsthatmeetjoinconditions,keepthe followinginmind: All (AND) join conditions. Ifthereplyingserviceexecutesbecausetwoormore documentssatisfiedanAll(AND)joincondition,theIntegrationServerusesthe envelopeofthelastdocumentthatsatisfiedthejoinconditiontodeterminewhere tosendthereplydocument.IfyouwanttheIntegrationServertousetheenvelope ofadifferentdocument,linktheenvelopeofthatdocumentto receivedDocumentEnvelope.Ifyouwanttoreplytoalldocumentsreceivedaspart ofanAll(AND)join,invokepub.publish:replyonceforeachdocumentreceivedand maptheenvelopefromthereceiveddocumenttoreceivedDocumentEnvelopefor eachcall. Any (OR) or Only one (XOR) join conditions.Ifthereplyingserviceexecutesbecausea documentsatisfiedanAny(OR)orOnlyone(XOR)joincondition,donotmapor assignavaluetoreceivedDocumentEnvelope.Itisimpossibletoknowwhich documentintheAny(OR)orOnlyone(XOR)joinwillbereceivedfirst.For example,supposethatanOnlyone(XOR)joinconditionspecifieddocument typesAandB.TheIntegrationServerusestheenvelopeofthedocumentit receivedfirstasthereceivedDocumentEnvelopevalue.Ifyoumaptheenvelopeof documentAtoreceivedDocumentEnvelope,buttheIntegrationServerreceives documentBfirst,yourreplyingservicewillfail.
363
19 Publish Folder
Important! Servicesthatpublishordeliveradocumentandwaitforareplycan specifyapublishabledocumenttypetowhichreplydocumentsmustconform.If thereplydocumentisnotofthetypespecifiedinthereceiveDocumentTypeName parameterofthepub.publish:publishAndWaitorpub.publish:deliverAndWaitservice,the publishingservicewillwaitforeverforareply.Workcloselywiththedeveloperof thepublishingservicetomakesurethatyourreplydocumentisaninstanceofthe correctpublishabledocumenttype. Formoreinformationaboutbuildingareplyservice,seethePublishSubscribe DevelopersGuide. See Also pub.publish:deliverAndWait pub.publish:publishAndWait pub.publish:envelope
pub.publish:waitForReply
WmPublic.Retrievesthereplyforanasynchronousrequest.Ifareplyisnotavailable,the IntegrationServercontinuestowaitforthedocumentuntilthetimespecifiedinthe waitTimeparameterofthepub.publish:deliverAndWaitorpub.publish:publishAndWaitservice elapses. Input Parameters tag StringAuniqueidentifierforthepublishrequestforwhichyouare retrievingareply.TheIntegrationServerusesthetagvalueto matchtherequestdocumentwithitscorrespondingreply document.
Output Parameters receivedDocument DocumentDocument(IDataobject)receivedasthereplytothe request.Iftherequestexpires(thatis,thewaitTimeelapses)before theIntegrationServerreceivesthereplydocument,the receivedDocumentfieldcontainsanulldocument. Important! TheIntegrationServertreatsallreplydocumentsas volatiledocuments.IftheIntegrationServershutsdownbefore processingthereplydocument,thereplydocumentislost.
364
19 Publish Folder
Usage Notes ThewaitTimevalueofthepublishingservicespecifieshowlongtheIntegrationServer willkeeptherequestopenwhilewaitingforareply.Whenbuildinganasynchronous request/replyservice,keepthefollowinginformationaboutthewaitTimeinmind: ThewaitingintervalforthereplydocumentstartswhentheIntegrationServer executestherequestservice(pub.publish:deliverAndWaitorpub.publish:publishAndWait). Theexecutionofthepub.publish:waitForReplyservicedoesnotaffectthewaitTime interval. IfthewaitTimeintervalelapsesbeforethepub.publish:waitForReplyserviceexecutes, theserviceimmediatelyreturnsanulldocumentwhichindicatesthatthewait timehasexpired. IftheIntegrationServerhasnotreceivedthereplywhenthepub.publish:waitForReply serviceexecutes,theservicewaitstheremainderofthewaitTimeinterval.Ifthe IntegrationServerdoesnotreceiveareplybythetimethewaitTimeinterval elapses,therequestcompletes.Theservicereturnsanulldocumentwhich indicatesthatthewaittimehasexpired. IfthereplydocumentarrivesafterthewaitTimeintervalelapses,theIntegration Serverrejectsthedocumentbecausetherequestisclosed. Asinglepublishandwaitrequestmightreceivemanyresponsedocuments.The IntegrationServerthatmadethepublishandwaitrequestusesonlythefirstreply documentitreceivesfromtheBroker.TheIntegrationServerdiscardsallother replies.Firstisarbitrarilydefined.Thereisnoguaranteeprovidedfortheorderin whichtheBrokerprocessesincomingreplies.Ifyouneedareplydocumentfroma specificclient,usethepub.publish:deliverAndWaitserviceinstead. Formoreinformationaboutbuildinganasynchronousrequest/replyservice,seethe PublishSubscribeDevelopersGuide. See Also pub.publish:deliverAndWait pub.publish:publishAndWait
365
19 Publish Folder
pub.publish.notification:error
WmPublic.PublishabledocumenttypethatdefinesthedocumentthattheIntegration Servergeneratesanddeliverswhenatriggerencountersanerrororexceptioncondition duringprocessing. TheIntegrationServergeneratesanerrordocumentifthetriggerservicecannot successfullyprocessadocumentforoneofthefollowingreasons: Thetriggerserviceencountersanexceptioncondition(thatisnotan ISRuntimeException)duringexecution. TheIntegrationServermakesthemaximumnumberofattemptstoreexecutethe triggerserviceandtheservicestillfailsbecauseofatransienterrorcondition. Someothersystemexceptionoccurred. Note: TheIntegrationServerdoesnotgenerateanerrordocumentifthesubscribing triggerispartofadisabledprocessmodelversionbecausethetriggerservice associatedwithadisabledprocessmodelversionneverexecutes. TheIntegrationServerdeliverstheerrordocumenttotheclientIDspecifiedinthe errorsTofieldcontainedinthereceiveddocumentsenvelope.IftheerrorsTofieldisempty, theIntegrationServerdeliverstheerrordocumenttotheoriginaldocumentspublisher (asspecifiedinthepubIdenvelopefield).Theerrordocumentnotifiesthepublisheror otherdesignatedrecipientthatthesubscribercannotprocessthedocumentsuccessfully. Note: Ifatriggerservicecannotprocessalocallypublisheddocumentsuccessfully,the IntegrationServerproducesanddeliversanerrordocumentonlyiftheIntegration ServerisconnectedtoaBroker. Parameters adapterType errorCategory errorText eventID StringOptional.Theresourceproducingtheerror.TheIntegration ServersetsthevalueofthisfieldtoIntegration Server. StringOptional.Typeofexception.TheIntegrationServersetsthe valueofthisfieldtoApplication. StringOptional.Exceptiontextmessage.AtDispatcherdebuglevel 9,astacktraceoftheexceptionwillalsobereturned. java.lang.LongOptional.TheeventIDofthedocumentthatcaused thisexception.Ifthetriggerserviceexecutedbecauseadocument satisfiedajoincondition,thentheeventIDistheeventIDofthelast documentthatsatisfiedthecondition. DocumentOptional.Adocumentreferencetothepub.publish:envelope documenttype.
_env
366
19 Publish Folder
Usage Notes TheclienttowhichtheIntegrationServerdeliverstheerrordocumentneedsto subscribetothepub.publish.notification:errordocumenttype.Iftheclientdoesnothavea triggerthatsubscribestothisdocumenttype,theclientwillneverreceiveorprocess theerrordocument.IftheclientreceivingtheerrordocumentisanIntegrationServer, itgeneratesthemessage[ISS.0098.0024V2] No trigger available for incoming Document pub.publish.notification:error. See Also pub.publish:envelope
367
19 Publish Folder
368
20
Remote Folder
YouusetheelementsintheremotefoldertoinvokeservicesonotherwebMethods IntegrationServers. Youcanalsouseremoteservicesforguaranteeddeliverytransactions.Formore informationaboutguaranteeddeliverytransactions,seetheGuaranteedDelivery DevelopersGuideandthewebMethodsIntegrationServerAdministratorsGuide.
369
20 Remote Folder

Thefollowingelementsareavailableinthisfolder: Element pub.remote:invoke pub.remote.gd:end pub.remote.gd:getStatus pub.remote.gd:invoke Package and Description WmPublic.InvokesaserviceonaremotewebMethods IntegrationServer. WmPublic.Endsaguaranteeddeliverytransaction. WmPublic.Returnsthestatusoftheguaranteeddelivery transaction. WmPublic.Invokestheserviceforaguaranteeddelivery transactionbymakingasynchronouscalltoaremote webMethodsIntegrationServer. WmPublic.Restartsanexpiredguaranteeddelivery transaction. WmPublic.Retrievestheresultsofaguaranteeddelivery transactionsubmittedasynchronouslyorsynchronously toaremotewebMethodsIntegrationServer. WmPublic.Makesaguaranteedonewaycall(fireand forget)tothewebMethodsIntegrationServertoinvokea serviceforwhichnooutputisneededorexpected. WmPublic.Startsaguaranteeddeliverytransaction. WmPublic.Invokesaserviceforaguaranteeddelivery transactionbymakinganasynchronouscalltoaremote webMethodsIntegrationServer.
pub.remote.gd:restart pub.remote.gd:retrieve
pub.remote.gd:send
pub.remote.gd:start pub.remote.gd:submit
pub.remote:invoke
WmPublic.InvokesaserviceonaremotewebMethodsIntegrationServer. Theremoteserverisidentifiedbyanalias,whichisconfiguredontheRemote Serverstab intheIntegrationServerAdministrator.Connectionandauthenticationtotheremote serverismanagedtransparentlytothecallerofthisservice. Allcurrentpipelineinputsarepassedtotheremoteservice.Toimproveperformanceand minimizetheamountofdatasentoverthewire,scopethepipelinetoaseparate documentordropunneededfieldsbeforeinvokingthisservice.Thesameadviceapplies totheoutputvaluesoftheremoteservicebecauseallvaluesreturnedfromtheserviceare sentoverthewireinresponsetothecaller.
370
20 Remote Folder
Input Parameters $alias StringNameofthetargetserveronwhichtoinvokethespecified service.Thisnameanditsassociatedconnectionattributesare definedontheCreate Remote Server Alias screenintheIntegration ServerAdministrator. Note: IfyouprotectthealiasusinganAccessControlList,theuser invokinginvokemustbeamemberofthislistortheinvocationwill fail. $service StringFullyqualifiednameoftheservicetoinvokeontheremote server,intheformatfolderName.folderName:serviceName(forexample: wm.server:ping). StringFlagthatspecifieshowthesessiontotheremoteservershould bemanaged. Set to...
SESSION
$scope
To... Default.Storetheremotesessioninthecurrentuser session.Furthercallsbythesameuserto pub.remote:invokeforthesameserveraliasreusethe existingremotesessionwiththeserver. Statefulinteractionswiththeremoteserverare maintainedandprotectedinsidethecurrentusers session. Whenthecurrentuserdisconnects,theremotesession expires,orthelocalserverisshutdown,theremote sessionisautomaticallydisconnected.
GLOBAL
Storetheremotesessioninasharedpoolofsessions.If anotheruserinvokesaserviceonthesameremote serverwithGLOBALscope,thesessionwillbereused. Statefulinteractionswiththeremoteservercouldbe destroyedbyotherusersinvocations. Whentheremotesessionexpiresduetoinactivityor thelocalserverisshutdown,theremotesessionis automaticallydisconnected.
Output Parameters Returnstheoutputoftheinvokedservice.Theoutputsignaturematchestheoutput signatureoftheinvokedservice.
371
20 Remote Folder
Usage Notes Ifpub.remote:invokedoesnotreceivearesponsewithinthetimeoutperiodspecifiedin theserverswatt.net.timeoutparameter,itwillthrowanexception.Forinformation aboutthewatt.net.timeoutparameter,seethewebMethodsIntegrationServer AdministratorsGuide.
pub.remote.gd:end
WmPublic.Endsaguaranteeddeliverytransaction. Input Parameters tid Output Parameters None. Usage Notes Thisserviceisusedtoeliminateaguaranteeddeliverytransactionfromthejobstore. StringTransactionIDofthetransactionyouwanttoend.
pub.remote.gd:getStatus
WmPublic.Returnsthestatusoftheguaranteeddeliverytransaction. Input Parameters tid Output Parameters status StringCurrentstatusofthetransaction.statuscanhaveoneofthe followingvalues: A value of...
NEW PENDING DONE FAILED
StringTransactionidentificationnumber.
Indicates that... Thetransactionisnew. Thetransactionispending. Thetransactioniscompleted. Thetransactionexpiredbecausethetimetoliveorthe retrylimithasbeenexceeded. Thetransactionidentificationnumberintidisnot recognized.
UNKNOWN
372
20 Remote Folder
Usage Notes Usethepub.remote.gd:restartservicetorestartaFAILED(expired)guaranteeddelivery transaction.
pub.remote.gd:invoke
WmPublic.Invokestheserviceforaguaranteeddeliverytransactionbymakinga synchronouscalltoaremotewebMethodsIntegrationServer. Input Parameters service tid inputs Output Parameters results Usage Notes Touseanasynchronouscalltotheservertoinvokeaserviceforaguaranteeddelivery transaction,usethepub.remote.gd:submitservice. Iftheremoteserverdoesnotrespondwithinthetimeoutlimitspecifiedinthis serverswatt.net.timeoutsetting,theIntegrationServertreatsitasafailedattempt andretriestherequest. DocumentConditional.Document(IDataobject)containingthe pipelineasitexistsaftertheserviceisinvoked. StringNameoftheservicetoberunontheremotewebMethods IntegrationServer. StringTransactionidentificationnumberfortheservice. DocumentOptional.Document(IDataobject)containingtheinputs fortheservice.
pub.remote.gd:restart
WmPublic.Restartsanexpiredguaranteeddeliverytransaction. Input Parameters tid Output Parameters None. StringTransactionidentificationnumberfortheguaranteeddelivery transactionyouwanttorestart.
373
20 Remote Folder
Usage Notes Ifaguaranteeddeliverytransactionfailedbecauseofserverornetworkfailure,use thisservicetorestartthetransactionwithoutresubmittingit.
pub.remote.gd:retrieve
WmPublic.Retrievestheresultsofaguaranteeddeliverytransactionsubmitted asynchronouslyorsynchronouslytoaremotewebMethodsIntegrationServer. Input Parameters tid block StringTransactionidentificationnumber. StringOptional.Flagthatspecifieswhethertoblockorpollforthe resultsofthetransaction. Set to...
true
To... Default.Waituntiltheinvokedservicecompletesbefore retrievingresults.Thisisalsoknownasblockingmode. Retrievetheresultsimmediately,whetherornotthe invokedserviceiscompleted.Thisisalsoknownas pollingmode.
false
Output Parameters results Usage Notes Ifblockisfalse,andtheresultsofthetransactionarestillpendingwhenthisservice executes,theresultsarereturnedasnull. DocumentConditional.Document(IDataobject)containingthe resultsoftheserviceintheguaranteeddeliverytransaction.
pub.remote.gd:send
WmPublic.Makesaguaranteedonewaycall(fireandforget)tothewebMethods IntegrationServertoinvokeaserviceforwhichnooutputisneededorexpected. Input Parameters service tid inputs StringServicetoberunontheremoteIntegrationServer. StringTransactionidentificationnumberfortheservice. DocumentOptional.Document(IDataobject)containingtheinputs fortheservice.
374
20 Remote Folder
Output Parameters None. Usage Notes Theresultsoftheservicespecifiedinservicecannotberetrieved.However,errorsthat occurwillbeloggedwhentheguaranteeddeliverytransactionends. Usethepub.remote.gd:sendservicetoinvokeaserviceremotelyonlyifyouwanttoruna guaranteeddeliverytransactionandarenotconcernedabouttheresultsofthe invokedservice.Afterpub.remote.gd:sendcompletesthecall,theserviceendsthe transaction;therefore,youdonotneedtousethepub.remote.gd:endservicetoendthe transaction.
pub.remote.gd:start
WmPublic.Startsaguaranteeddeliverytransaction. Input Parameters alias StringNameofthewebMethodsIntegrationServeronwhichyou wanttoinvokeaguaranteeddeliverytransaction.Thisnameandits associatedconnectionattributesaredefinedontheRemote Servers taboftheIntegrationServerAdministrator. StringOptional.Transactiontimetolivemeasuredinminutes.The transactionexpireswhenttlisexceeded. Defaultisthevaluesetinthewatt.tx.defaultTTLMinspropertyor,if thepropertyisnotset,30minutes. retries followtid StringOptional.Maximumnumberoftimestoretrythetransaction. Defaultis0(noretrylimit). StringOptional.Identificationnumberofthetransactionyouwant thisguaranteeddeliverytransactiontofollow.Thecurrent transactionexecutesonlyafterthetransactionindicatedbyfollowtid completes.
ttl
Output Parameters tid StringTransactionidentificationnumber.
375
20 Remote Folder
pub.remote.gd:submit
WmPublic.Invokesaserviceforaguaranteeddeliverytransactionbymakingan asynchronouscalltoaremotewebMethodsIntegrationServer. Input Parameters service tid inputs Output Parameters None. Usage Notes ToremovethetransactionfromtheremotewebMethodsIntegrationServer,usethe pub.remote.gd:endservice. Touseasynchronouscalltoinvoketheservice,usethepub.remote.gd:invokeservice. StringServicetoberunontheremotewebMethodsIntegration Server. StringTransactionidentificationnumberfortheservice. DocumentOptional.Document(IDataobject)containingtheinputs fortheservice.
376
21
Replicator Folder
YouusetheelementsinthereplicatorfoldertoreplicatepackagesacrosswebMethods IntegrationServers.Thisfoldercontainsservicesthatyoucanusetopushpackagesfrom yourwebMethodsIntegrationServerstoasubscribersserver.Italsocontainsservices thatyoucanusetopullpackagesfromapublishersservertoyourwebMethods IntegrationServer.
377
21 Replicator Folder

Thefollowingelementsareavailableinthisfolder: Element pub.replicator:addReleaseRegistryEntry pub.replicator:deleteReleaseRegistryEntry Package and Description WmPublic.AddsanentrytothewebMethods IntegrationServersPackageReleaseRegistry. WmPublic.Deletesanentryfromthe webMethodsIntegrationServersPackage ReleaseRegistry. WmPublic.Allowsapublishertosenda packagetoasubscriberviaFTPorallowsa subscribertoretrieveapackagefroma publisherviaFTP. WmPublic.Pullsaspecifiedpackagerelease fromapublishersserver. WmPublic.Pushesapackagefromyourserver toalistofsubscribers(otherwebMethods IntegrationServers). WmPublic.Generatesareplicationevent. WmPublic.Returnsallentriesinyour webMethodsIntegrationServersPackage ReleaseRegistry. WmPublic.Queriesthepublisherforreleased packages. WmPublic.Sendsanemailmessageto subscriberswhohavesaidthattheywanttobe notifiedwhenanewreleasebecomesavailable. WmPublic.Createsadistributionfile(azipfile) forthepackage.
pub.replicator:distributeViaFTP
pub.replicator:distributeViaSvcPull pub.replicator:distributeViaSvcPush
pub.replicator:generateReplicationEvent pub.replicator:getLocalReleasedList
pub.replicator:getRemoteReleasedList pub.replicator:notifyPackageRelease
pub.replicator:packageCreation
378
pub.replicator:addReleaseRegistryEntry
WmPublic.AddsanentrytothewebMethodsIntegrationServersPackageRelease Registry. Input Parameters package StringNameofthepackage.Theserviceconfirmsthatthispackage existsontheserverbeforeaddinganentrytothePackageRelease Registry. StringNameoftherelease.Thisnamecouldbedifferentfromthename ofthepackage. StringVersionnumberoftherelease,intheformat#.#or#.#.#(for example,1.2or1.2.1). StringBuildnumberoftherelease(forexample,12, 530). StringOneormorecommaseparatedpatchnumbersincludedinthis release. StringMinimumJVMversionnumberthatthisreleaserequires. StringBriefdescriptionofthisrelease.Youmaywanttousethis parametertosummarizethenatureandpurposeoftherelease.
name version build patchNums JVMVersion description
Output Parameters packages Document List EntriesintheserversPackageReleaseRegistry. Key name version build patch_nums time jvm_version description source_server_version Description StringNameoftherelease. StringVersionnumberoftherelease,inthe format#.#or#.#.#(forexample,1.2or1.2.1). StringConditional.Buildnumberoftherelease (forexample,12, 530). StringConditional.Commaseparatedlistof patchnumbersincludedinthisrelease. StringTimewhenthepackagewasreleased. StringMinimumJVMversionnumberthatthe releaserequires. StringConditional.Briefdescriptionofthis release. StringVersionnumberofIntegrationServerthat releasedthepackage.
379
Usage Notes Beforeusingthisservice,usepub.replicator:packageCreationtocreateapackagezipfilein theserversoutbounddirectory.WhenyouuseaddReleaseRegistryEntrytoaddanentry tothePackageReleaseRegistry,thepackagenameyouspecifyinpackageshould matchthepackagenameyouspecifiedinpub.replicator:packageCreation.
pub.replicator:deleteReleaseRegistryEntry
WmPublic.DeletesanentryfromthewebMethodsIntegrationServersPackageRelease Registry. Input Parameters packageName StringNameofthereleasethatyouwanttodelete.
Output Parameters packages Document List EntriesthatremainintheserversPackageRelease Registry. Key name version Description StringNameoftherelease. StringVersionnumberoftherelease,inthe format#.#or#.#.#(forexample,1.2or 1.2.1). StringConditional.Buildnumberofthe release(forexample,12,530). StringConditional.Commaseparatedlist ofpatchnumbersincludedinthisrelease. StringTimewhenthepackagewasreleased. StringMinimumJVMversionnumberthat thereleaserequires. StringConditional.Briefdescriptionofthe release. StringVersionnumberofIntegrationServer thatreleasedthepackage.
build patch_nums time jvm_version description source_server_version
380
pub.replicator:distributeViaFTP
WmPublic.AllowsapublishertosendapackagetoasubscriberviaFTPorallowsa subscribertoretrieveapackagefromapublisherviaFTP. Input Parameters packageName action StringNameofthereleasedpackage. StringFlagthatspecifieswhetheryouwanttosend(put)apackageto anotherIntegrationServerorwhetheryouwanttoretrieve(get)a packagefromanotherIntegrationServer. Set to...
get put
To... Default.Retrieveapackagefromthepublishersserver. Sendapackagetoasubscribersserver.
serverhost serverport username password Output Parameters None.
StringHostnameorIPaddressoftheremoteIntegrationServer. StringNumberoftheFTPportontheremoteIntegrationServer. StringUsernamethatyourserverwillusetologontotheremote IntegrationServer. StringPasswordthatyourserverwillusetologontotheremote IntegrationServer.
pub.replicator:distributeViaSvcPull
WmPublic.Pullsaspecifiedpackagereleasefromapublishersserver. Input Parameters packageName publisher Output Parameters None. StringNameoftherelease. StringAliasofthepublishersserver.
381
pub.replicator:distributeViaSvcPush
WmPublic.Pushesapackagefromyourservertoalistofsubscribers(otherwebMethods IntegrationServers). Input Parameters packageName subscriber Output Parameters None. StringThenameoftherelease. String ListListofthesubscribershostnamesorIPaddresses.
pub.replicator:generateReplicationEvent
WmPublic.Generatesareplicationevent. Youmightinvokethisserviceinconjunctionwithotherservicestomakethepackage replicationprocessgenerateanevent.Thereplicationeventhandlerwouldlistenforthis eventandperformsomeprescribedactionthatyouhavespecified. Input Parameters packageName action Output Parameters None. StringNameofthepackage. StringUserdefinedstringthatdescribesthereplicationevent,such aspulledorpushed.
pub.replicator:getLocalReleasedList
WmPublic.ReturnsallentriesinyourwebMethodsIntegrationServersPackageRelease Registry. Input Parameters None.
382
Output Parameters packages Document ListEntriesintheserversPackageReleaseRegistry. Key name version build patch_nums time jvm_version description source_server_version Description StringNameoftherelease. StringVersionnumberoftherelease,inthe format#.#or#.#.#(forexample,1.2or1.2.1). StringConditional.Buildnumberoftherelease (forexample,12,530). StringConditional.Commaseparatedlistofthe patchnumbersincludedinthisrelease. StringTimewhenthepackagewasreleased. StringMinimumJVMversionnumberthatthe releaserequires. StringConditional.Briefdescriptionofthe release. StringVersionnumberofwebMethods IntegrationServerthatreleasedthepackage.
pub.replicator:getRemoteReleasedList
WmPublic.Queriesthepublisherforreleasedpackages. Thisservicegetsalistofreleasedpackagestowhichyourserversubscribes.Youcanuse thelisttofindoutifanynewpackages,ornewerversionsofexistingpackages,havebeen released. Input Parameters publisher StringAliasofthepublishingserver.
Output Parameters packages Document List Listofreleasedpackagesonthepublishingservertowhich yousubscribe. Key name version build Description StringNameoftherelease. StringVersionnumberoftherelease,inthe format#.#or#.#.#(forexample,1.2or1.2.1). StringConditional.Buildnumberofthe release(forexample,12,530).
383
patch_nums time jvm_version description source_server_version
StringConditional.Commaseparatedlistof thepatchnumbersincludedinthisrelease. StringTimewhenthepackagewasreleased. StringMinimumJVMversionnumberthatthe releaserequires. StringConditional.Briefdescriptionofthe release. StringVersionnumberofwebMethods IntegrationServerthatreleasedthepackage.
pub.replicator:notifyPackageRelease
WmPublic.Sendsanemailmessagetosubscriberswhohavesaidthattheywanttobe notifiedwhenanewreleasebecomesavailable. Input Parameters packageName Output Parameters None. StringNameoftherelease.
pub.replicator:packageCreation
WmPublic.Createsadistributionfile(azipfile)forthepackage. Input Parameters package name version build patchNums targetPkgVersion StringNameofthepackage. StringNameoftherelease. StringVersionnumberoftherelease,intheformat#.#or#.#.#(for example,1.2or1.2.1). StringBuildnumberoftherelease(forexample,12,530). StringCommaseparatedlistofpatchnumbersincludedinthe release. StringVersionnumberofthetargetpackage.Topreventthe installationprogramfromoverwritinganexisting(higher) versionofthepackage,thisfieldischeckedwhenthesubscriber installsthispackageoveranexistingpackage.
384
targetServerVersion JVMVersion description type
StringVersionnumberofthewebMethodsIntegrationServerthat thisreleaserequires. StringMinimumJVMversionnumberthatthisreleaserequires. StringBriefdescriptionofthisrelease.Youmightusethis parametertosummarizethenatureandpurposeoftherelease. StringFlagindicatingthetypeofrelease. Set to...

full partial
To... Default.Indicateafullpackage. Indicateapatchoranupdateforthepackage.
filter
StringFlagthatspecifieswhetherallfilesaretobeincludedinthe distributionfileoronlyselectedfiles. Ifonlyselectedfilesaretobeincluded,usethisparameterin conjunctionwithfileListtospecifywhichfilestoinclude. Set to...

includeall include exclude
To... Default.Includeallthefilesinthedistributionfile. Includeselectedfilesinthedistributionfile. Includeallexceptselectedfilesinthedistribution file.
fileList fileNamePattern
String List Namesoffilestoincludeorexcludefromthe distributionfile,dependingonthevalueoffilter. StringPatternstringthatspecifiesthenamesoffilestobe includedinthedistributionfile.Theasterisk(*)istheonly wildcardcharacterallowedinapatternstring.Allother charactersaretreatedliterally(forexample,*.java,*.dsp). String List Optional.Thenamesoffilesthatwillbedeletedfrom thetargetpackagewhenthesubscribingserverinstallsthe packagecreatedbythisservice.
filesToDeleteList
Output Parameters $result StringConditional.Ifthedistributionfileiscreatedsuccessfully,this parametercontainsthevalueOK.Ifthedistributionfilewasnot createdsuccessfully,thisparameterisnotpresentintheoutput signatureandtheservicethrowsanexception.
385
Usage Notes AfteryouusepackageCreationtocreatethepackage,use pub.replicator:addReleaseRegistryEntrytoaddanentrytothePackageReleaseRegistry.The packagenameyouspecifyinpackageCreationshouldmatchthepackagenameyou specifyinpub.replicator:addReleaseRegistryEntry.
386
22
Report Folder
YouusetheelementsinthereportfoldertoapplyanoutputtemplatetoaValuesobject. EachservicerequiresanoutputtemplateandaValuesobject.Theycanbeusedinorder togenerateanytypeofdynamicXML,EDI,orHTMLdocument.
387
22 Report Folder

Thefollowingelementsareavailableinthisfolder: Element pub.report:runFileTemplate pub.report:runFileTemplateOnPipe pub.report:runStringTemplate pub.report:runStringTemplateOnPipe pub.report:runTemplate pub.report:runTemplateOnPipe Package and Description WmPublic.Appliesatemplatefiletoadocument (IDataobject). WmPublic.Appliesatemplatetothepipeline. WmPublic.Appliesanoutputtemplatetoaspecified document(IDataobject). WmPublic.Appliesatemplatetothepipeline. WmPublic.Appliesatemplateinafiletoaspecified document(IDataobject). WmPublic.Appliesatemplateinafiletothe pipeline.
pub.report:runFileTemplate
WmPublic.Appliesatemplatefiletoadocument(IDataobject). Input Parameters $template $values fileEncoding java.io.FileTemplatefile. DocumentDocument(IDataobject)tobindagainst$template. StringOptional.Theencodingofthetemplatefile.IffileEncodingis notspecified,thedefaultfileencodingspecifiedinthe watt.server.netEncodingserverparameterorthesystemfile encodingwillbeused.Examples:SJIS,ASCII,ISO8859_1.
Output Parameters $txt Usage Notes Ifatemplateisnotavailableinatemplatesdirectoryofanyofthepackagesonthe server,youcanusethisservicebypassinginaFileobjectrepresentingthetemplate. StringResultsfromapplying$templateto$values.
388
22 Report Folder
pub.report:runFileTemplateOnPipe
WmPublic.Appliesatemplatetothepipeline. Input Parameters $template fileEncoding java.io.FileTemplatefile. StringOptional.Theencodingofthetemplatefile.IffileEncodingis notspecified,thedefaultfileencodingspecifiedinthe watt.server.netEncodingserverparameterorthesystemfile encodingwillbeused.Examples:SJIS,ASCII,ISO8859_1.
Output Parameters $txt Usage Notes Ifatemplateisnotavailableinatemplatesdirectoryofanyofthepackagesonthe server,youcanusethisservicetopassaFileobjectrepresentingthetemplatefile. StringResultsfromapplying$templatetothepipeline.
pub.report:runStringTemplate
WmPublic.Appliesanoutputtemplatetoaspecifieddocument(IDataobject). Input Parameters $template $values Output Parameters $txt Usage Notes Thisserviceistypicallyinvokedfromotherservicesthatalreadyhaveatemplateina StringobjectandanIDataobjectthatwillbeusedtobindagainstthetemplate. StringResultsfromapplying$templateto$values. StringTemplatetoapply. DocumentDocument(IDataobject)tobindagainst$template.
pub.report:runStringTemplateOnPipe
WmPublic.Appliesatemplatetothepipeline. Input Parameters $template StringTemplatetoapplytopipeline.
389
22 Report Folder
Output Parameters $txt Usage Notes Thisserviceistypicallyinvokedfromotherservicesthatalreadyhaveatemplateina Stringobjectandneedthetemplatetobindagainstthepipeline. StringResultfromapplying$templatetothepipeline.
pub.report:runTemplate
WmPublic.Appliesatemplateinafiletoaspecifieddocument(IDataobject). Input Parameters $template $package $values fileEncoding StringNameofthetemplatefile(forexample,mytemp.htmlor
mytemp.xml).
StringNameofthepackagewherethetemplateresides(forexample, Default). DocumentDocument(IDataobject)tobindagainst$template. StringOptional.Theencodingofthetemplatefile.IffileEncodingis notspecified,thedefaultfileencodingspecifiedinthe watt.server.netEncodingserverparameterorthesystemfile encodingwillbeused.Examples:SJIS,ASCII,ISO8859_1.
Output Parameters $txt Usage Notes Theservicelocatestheoutputtemplatebyitsfilenameandthenameofthepackage inwhichitresides.Toapplyatemplatethatresidesin IntegrationServer_directory\packages\Default\templates\mytemp.xml,invokethe servicewiththefollowingvalues. $template:mytemp.xml $package:Default StringResultfromapplyingthetemplateto$values.
390
22 Report Folder
pub.report:runTemplateOnPipe
WmPublic.Appliesatemplateinafiletothepipeline. Input Parameters $template $package fileEncoding StringNameoftemplatefile(forexample,mytemp.htmlor mytemp.xml). StringNameofthepackageinwhichthetemplateresides(for example,Default). StringOptional.Theencodingofthetemplatefile.IffileEncodingis notspecified,thedefaultfileencodingspecifiedinthe watt.server.netEncodingserverparameterorthesystemfile encodingwillbeused.Examples:SJIS,ASCII,ISO8859_1.
Output Parameters $txt Usage Notes Theservicelocatestheoutputtemplatebyitsfilenameandthenameofthepackage inwhichitresides.Toapplyatemplatethatresidesin IntegrationServer_directory\packages\Default\templates\mytemp.xml,Invokesthe servicewiththefollowingvalues. $template:mytemp.xml $package:Default StringResultsfromapplyingthetemplatefiletothepipeline.
391
22 Report Folder
392
23
Scheduler Folder
Youusetheelementsintheschedulerfoldertoexecuteservicesatthetimesyouspecify. Servicesthatyouschedulearereferredtoasusertasksorjusttasks.TheSchedulerfeature onthewebMethodsIntegrationServerhandlesexecutionofthetasks.
393
23 Scheduler Folder

Thefollowingelementsareavailableinthisfolder: Element pub.scheduler:addComplexTask pub.scheduler:addOneTimeTask pub.scheduler:addRepeatingTask pub.scheduler:cancelTask pub.scheduler:getTaskIDs pub.scheduler:getTaskInfo pub.scheduler:migrateTasksToJDBC Package and Description WmPublic.AddsacomplextasktotheScheduler. WmPublic.Addsataskthatrunsonlyoncetothe Scheduler. WmPublic.AddsarecurringtasktotheScheduler. WmPublic.RemovesataskfromtheScheduler. WmPublic.Retrievesalistofidentificationnumbers fortaskscurrentlyintheScheduler. WmPublic.Retrievesinformationaboutataskonthe Scheduler. WmPublic.Migratesscheduledusertasksfromthe IntegrationServerembeddeddatabasetoanexternal database. WmPublic.Resumesasuspendedtask. WmPublic.SuspendsataskontheScheduler. WmPublic.UpdatesacomplextaskontheScheduler. WmPublic.UpdatesaonetimetaskontheScheduler. WmPublic.UpdatesarepeatingtasktotheScheduler.
pub.scheduler:resumeTask pub.scheduler:suspendTask pub.scheduler:updateComplexTask pub.scheduler:updateOneTimeTask pub.scheduler:updateRepeatingTask
pub.scheduler:addComplexTask
WmPublic.AddsacomplextasktotheScheduler. ThewebMethodsIntegrationServerrunstheserviceforacomplextaskontheday(s)and time(s)thatyouspecifyeitherduringaspecifieddaterangeorindefinitely. Input Parameters service description StringNameoftheserviceyouwanttoscheduleforexecutiononthe server. String Textstringdescribingthistask.
394
23 Scheduler Folder
target
String Serverorserversonwhichthetaskistorun.(Clustered environmentsonly). Set to...

$any
To... Runthetaskonanyserverinthecluster.Thetask willrunononlyoneoftheservers. Forexample,supposethatalltheserversinyour clustershareasingledatabaseforaparts inventoryapplication,andthataparticular functionneedstorunagainstthatdatabaseoncea day.Anyoftheserverscanperformthistask, thereforeyoucanspecifythe$alloptionto scheduleatasktorunonanyoftheservers. Note: Thereisnopredeterminedorderinwhich serversintheclusterareselectedtoruntasks. Rather,thefirstservertodetectthatataskisready tobeexecutedrunsit. FormoreinformationabouthowIntegration Serverhandlestheschedulingoftasksina clusteredenvironment,seethechapterabout managingservicesinthewebMethodsIntegration ServerAdministratorsGuide.
$all
Runthetaskonallserversinthecluster. Forexample,supposeyourunanapplicationon eachserverinthecluster,andeachserver maintainsitsowndatabaseforthatapplication.If youneedtorunacleanuptaskagainstallthe databaseseveryday,youcanscheduleataskto runeverydayonalltheserversinthecluster. FormoreinformationabouthowIntegration Serverhandlestheschedulingoftasksina clusteredenvironment,seethechapterabout managingservicesinthewebMethodsIntegration ServerAdministratorsGuide.
hostname:port
Runthetaskonaspecificserverinthecluster.
395
23 Scheduler Folder
lateness
String Thenumberofminutes(afterthescheduledexecutiontime) afterwhichtheserveristotakeaspecialactionforalatetask.You specifytheactiontobetakeninthelatenessActionparameter, describedbelow.Theserverchecksscheduledtasksatstartup,and againperiodically.Iftheserverfindsataskthatisoverdueandhas exceededthelatenessperiod,theserverperformstherequested latenessaction.Iftheserverfindsataskthatisoverduebuthasnot yetexceededthelatenessperiod,theserverstartsthetask immediately. String Actiontotakeifataskhasmisseditsscheduledstarttimebya numberofminutesyouspecifiedwiththelatenessparameter. Possibleactionsare: run immediately or 0 Runsthetaskimmediately skip and run at next scheduled interval or 1 Skipsthisexecutionofthetaskandrunsitagainatthenext scheduledruntime. suspend or 2 Placesthetaskinasuspendedstateuntilanadministratorresumes orcancelsthetask.
latenessAction
runAsUser inputs startTime
StringOptional.UserIDunderwhichtheserviceistobeexecuted.If youdonotspecifyausername,theDefaultaccessrightsareused. DocumentOptional.Document(IDataobject)containingtheinputto thescheduledservice. StringOptional.Timeatwhichthetaskisscheduledtostart,inthe formatHH:mm:ss.IfyoudonotspecifyastartTime,thecurrenttime isused. StringOptional.Dateonwhichthetaskisscheduledtostart,inthe formatyyyy/MM/dd.IfyoudonotspecifyastartDate,thecurrent dateisused. StringOptional.Timeatwhichthetaskexpires,intheformat HH:mm:ss.IfyoudonotspecifyanendTime,theserverusesthe currenttime. StringOptional.Dateonwhichthetaskexpires,intheformat yyyy/MM/dd.IfyoudonotspecifyanendDate,theserverexecutes thisserviceforanindefiniteperiodoftime. String List Optional.Monthsduringwhichthetaskisscheduledto run.Monthsarerepresentedbyintegersbetween1and12,where 1indicatesJanuaryand12indicatesDecember.Ifyoudonot specifymonths,thetaskwillruneverymonth.
startDate
endTime
indite
months
396
23 Scheduler Folder
hours
String List Optional.Hoursatwhichthetaskisscheduledtorun. Hoursarerepresentedbyintegersbetween0and23.Ifyoudonot specifyhours,thetaskrunseveryhour. String List Optional.Minutesatwhichthetaskisscheduledtorun. Minutesarerepresentedbyintegersbetween0and59.Ifyoudonot specifyminutes,thetaskrunseveryminute. String List Optional.Daysofthemonthonwhichthetaskis scheduledtorun.Daysarerepresentedbyintegersbetween1and 31.IfyoudonotspecifydaysOfMonth,thetaskrunseverydayofthe month. String List Optional.Daysoftheweekonwhichthetaskisscheduled torun.Daysarerepresentedbyintegersbetween1and7,where1 indicatesSundayand7indicatesSaturday.Ifyoudonotspecify daysOfWeek,thetaskrunseverydayoftheweek.
minutes
daysOfMonth
daysOfWeek
Output Parameters taskID type taskAdded StringIdentificationnumberofthetaskaddedtothescheduler. StringCodeindicatingthetypeoftaskadded.Forthistypeoftask,the valueoftypewillbecomplex. StringIndicateswhetherthetaskwassuccessfullyaddedtothe Scheduler.IfthetaskwassuccessfullyaddedtotheScheduler, taskAddedcontainstrue.Ifthetaskwasnotsuccessfullyadded,the serverthrowsanexceptionandterminatestheservice.
pub.scheduler:addOneTimeTask
WmPublic.AddsataskthatrunsonlyoncetotheScheduler. TheIntegrationServerexecutestheserviceasingletimeonthedateandtimeyouspecify. Input Parameters service description StringNameoftheserviceyouwanttoscheduleforexecution. StringTextstringdescribingthistask.
397
23 Scheduler Folder
target
StringServerorserversonwhichthetaskistorun.(Clustered environmentsonly). Set to...

$any
To... Runthetaskonanyserverinthecluster.Thetask willrunononlyoneoftheservers. Forexample,supposethatalltheserversinyour clustershareasingledatabaseforapartsinventory application,andthataparticularfunctionneedsto runagainstthatdatabaseonceaday.Anyofthe serverscanperformthistask,thereforeyoucan specifythe$alloptiontoscheduleatasktorunon anyoftheservers. Note: Thereisnopredeterminedorderinwhich serversintheclusterareselectedtoruntasks. Rather,thefirstservertodetectthatataskisready tobeexecutedrunsit. FormoreinformationabouthowIntegrationServer handlestheschedulingoftasksinaclustered environment,seethechapteraboutmanaging servicesinthewebMethodsIntegrationServer AdministratorsGuide.
$all
Runthetaskonallserversinthecluster. Forexample,supposeyourunanapplicationon eachserverinthecluster,andeachserver maintainsitsowndatabaseforthatapplication.If youneedtorunacleanuptaskagainstallthe databaseseveryday,youcanscheduleatasktorun everydayonalltheserversinthecluster. FormoreinformationabouthowIntegrationServer handlestheschedulingoftasksinaclustered environment,seethechapteraboutmanaging servicesinthewebMethodsIntegrationServer AdministratorsGuide.
hostname:port
398
23 Scheduler Folder
lateness
latenessAction
runAsUser inputs date time Output Parameters taskID type taskAdded
StringOptional.UserIDunderwhichtheserviceistobeexecuted.If youdonotspecifyausername,theDefaultaccessrightsareused. DocumentOptional.Document(IDataobject)containinginputtothe scheduledservice. StringDateonwhichtoruntheservice,intheformatyyyy/MM/dd. StringTimeatwhichtoruntheservice,intheformatHH:mm:ss.
StringIdentificationnumberofthetaskaddedtothescheduler. StringCodeindicatingthetypeoftaskadded.Forthistypeoftask, thevalueoftypewillbeonce. StringIndicateswhetherthetaskwassuccessfullyaddedtothe Scheduler.IfthetaskwassuccessfullyaddedtotheScheduler, taskAddedcontainstrue.Ifthetaskwasnotsuccessfullyadded,the serverthrowsanexceptionandterminatestheservice.
399
23 Scheduler Folder
pub.scheduler:addRepeatingTask
WmPublic.AddsarecurringtasktotheScheduler. ThewebMethodsIntegrationServercontinuallyexecutesarepeatingtaskattheinterval youspecify. Input Parameters service description target StringNameoftheserviceyouwanttoscheduleforexecutiononthe server. String Text string describing this task. String Server or servers on which the task is to run. (Clustered environmentsonly). Set to...
$any
To... Runthetaskonanyserverinthecluster.Thetask willrunononlyoneoftheservers. Forexample,supposethatalltheserversinyour clustershareasingledatabaseforapartsinventory application,andthataparticularfunctionneedsto runagainstthatdatabaseonceaday.Anyofthe serverscanperformthistask,thereforeyoucan specifythe$alloptiontoscheduleatasktorunon anyoftheservers. Note: Thereisnopredeterminedorderinwhich serversintheclusterareselectedtoruntasks. Rather,thefirstservertodetectthatataskisready tobeexecutedrunsit. FormoreinformationabouthowIntegration Serverhandlestheschedulingoftasksina clusteredenvironment,seethechapterabout managingservicesinthewebMethodsIntegration ServerAdministratorsGuide.
400
23 Scheduler Folder
$all
Runthetaskonallserversinthecluster. Forexample,supposeyourunanapplicationon eachserverinthecluster,andeachserver maintainsitsowndatabaseforthatapplication.If youneedtorunacleanuptaskagainstallthe databaseseveryday,youcanscheduleatasktorun everydayonalltheserversinthecluster. FormoreinformationabouthowIntegration Serverhandlestheschedulingoftasksina clusteredenvironment,seethechapterabout managingservicesinthewebMethodsIntegration ServerAdministratorsGuide.
hostname:port
lateness
latenessAction
StringOptional.UserIDunderwhichtheserviceistobeexecuted.If youdonotspecifyausername,theDefaultaccessrightsareused. DocumentOptional.Document(IDataobject)containinginputtothe scheduledservice. StringOptional.Timeatwhichthetaskisscheduledtostart,in HH:mm:ssformat.IfyoudonotspecifyastartTime,thecurrenttime isused.
401
23 Scheduler Folder
startDate
StringOptional.Dateonwhichthetaskisscheduledtostart,in yyyy/MM/dd format.Ifyoudonotspecifydate,thecurrentdateis used. StringOptional.Timeatwhichthetaskexpires,inHH:mm:ssformat. IfyoudonotspecifyanendTime,theserverusesthecurrenttime. StringOptional.Dateonwhichthetaskexpires,inyyyy/MM/dd format.IfyoudonotspecifyanendDate,theserverexecutesthis serviceforanindefiniteperiodoftime. StringTimeinterval(measuredinseconds)betweenexecutionsof thetask. StringOptional.Flagthatindicateswhetheryouwantexecutionsof thistasktooverlap. Set to...
true
endTime endDate
interval doNotOverlap
To... Preventexecutionsofthescheduledtaskfrom overlapping.Afterascheduledtaskfinishes executing,theSchedulerwaitsthenumberof secondsspecifiedinintervalbeforerunningthe taskagain. Default.Allowexecutionsofthescheduledtaskto overlap.TheSchedulerrunsthetaskeverytimethe valueofintervalelapses.
false
Output Parameters taskID type taskAdded StringIdentificationnumberofthetaskaddedtotheScheduler. StringCodeindicatingthetypeoftaskadded.Forthistypeoftask,the valueoftypewillberepeat. StringIndicateswhetherthetaskwassuccessfullyaddedtothe Scheduler.IfthetaskwassuccessfullyaddedtotheScheduler, taskAddedcontainstrue.Ifthetaskwasnotsuccessfullyadded,the serverthrowsanexceptionandterminatestheservice.
402
23 Scheduler Folder
pub.scheduler:cancelTask
WmPublic.RemovesataskfromtheScheduler. Input Parameters taskID StringIdentificationnumberofthetasktoremovefromthe Scheduler. Ifyourserverrunsaspartofaclusterofservers,andyouhave scheduledatasktorunonallserversinthecluster,notethe followingbeforecancelingatask: Ifyoucancelaparenttask,thetaskwillbecanceledonallservers inthecluster. Ifyoucancelachildtask,thetaskwillbecanceledonlyonthe serveronwhichthechildtaskwasscheduledtorun. Formoreinformationaboutparentandchildtasks,see pub.scheduler:getTaskInfoonpage 404orthechapterabout managingservicesinthewebMethodsIntegrationServer AdministratorsGuide. Output Parameters taskCancelled StringIndicateswhetherthetaskwassuccessfullyremovedfromthe Scheduler.IfthetaskwassuccessfullyremovedfromtheScheduler, taskCancelledcontainstrue.Ifthetaskwasnotsuccessfullyremoved, theserverthrowsanexceptionandterminatestheservice.
Usage Notes ForinformationaboutthetasksontheScheduler,runthepub.scheduler:getTaskIDsand pub.scheduler:getTaskInfoservices.
pub.scheduler:getTaskIDs
WmPublic.RetrievesalistofidentificationnumbersfortaskscurrentlyintheScheduler. Input Parameters running StringSpecifieswhethertheservicereturnstaskIDsforalltasksor justtasksthatarerunning.Ifyouspecifyfalse(thedefault),the servicereturnstaskIDsforalltasks.Ifyouspecifytrue,theservice returnstaskIDsforjustthosetaskswiththestatusrunning.
403
23 Scheduler Folder
Output Parameters taskIDs String ListIdentificationnumbersforthetasksontheScheduler.
pub.scheduler:getTaskInfo
WmPublic.RetrievesinformationaboutataskontheScheduler. Input Parameters taskID Output Parameters type StringCodeindicatingthetaskstype.Willbeoneofthefollowing:
complex once repeat
StringTaskidentificationnumber.
runAsUser target
StringTheuserIDwhoseaccessrightsareusedtoexecutetheservice. String Serverorserversonwhichthetaskistorun.(Clustered environmentsonly). A value of...

$any
Indicates that... The task will run on any, but only one, server in the cluster. Formoreinformationaboutscheduledtasksina clusteredenvironment,seethechapterabout managingservicesinthewebMethodsIntegration ServerAdministratorsGuide.
404
23 Scheduler Folder
$all
The task will run on all servers in a cluster. Whenyouscheduleatasktorunonallserversinthe cluster,theserverdividesthetaskintoamainor parenttask,andachildtaskforeachserverinthe cluster.Youcanperformsomeactions(activate, suspend,delete)individuallyonthechildtasks,but ifyouwanttochangethecharacteristicsofatask, youmustdosothroughtheparenttask. Foraparenttask,thisservicereturns$allinthe Targetparameter. Foreachchildtask,thisservicereturnsthe hostname:portonwhichthetaskistorun. Formoreinformationaboutscheduledtasksina clusteredenvironment,seethechapterabout managingservicesinthewebMethodsIntegration ServerAdministratorsGuide.
hostname:port
That the task will run on this particular server. This service returns hostname:port if: Yourserverisrunninginacluster,ataskwas scheduledtorunonallserversinthecluster,and thisisoneofthechildtasks.(Seethedescription of$allabove.) Yourserverisrunninginaclusterandyou requestedaspecificserver. Yourserverisnotrunninginacluster. Formoreinformationaboutscheduledtasksina clusteredenvironment,seethechapterabout managingservicesinthewebMethodsIntegration ServerAdministratorsGuide.
description lateness
String Text string describing this task. String Thenumberofminutes(afterthescheduledexecutiontime) afterwhichtheserveristotakeaspecialactionforalatetask.You specifytheactiontobetakeninthelatenessActionparameter, describedbelow.Theserverchecksscheduledtasksatstartup,and againperiodically.Iftheserverfindsataskthatisoverdueandhas exceededthelatenessperiod,theserverperformstherequested latenessaction.Iftheserverfindsataskthatisoverduebuthasnot yetexceededthelatenessperiod,theserverstartsthetask immediately.
405
23 Scheduler Folder
latenessAction
String Actiontotakeifataskhasmisseditsscheduledstarttimebya numberofminutesyouspecifyinthelatenessparameter.Possible actionsare: run immediately or 0 Runsthetaskimmediately skip and run at next scheduled interval or 1 Skipsthisexecutionofthetaskandrunsitagainatthenext scheduledruntime. suspend or 2 Placesthetaskinasuspendedstateuntilanadministratorresumesor cancelsthetask.
service nextRun
StringNameoftheserviceassociatedwiththetask. StringNextdateandtimethatthetaskisscheduledtorun.Thedate andtimeisexpressedasthenumberofmillisecondsfromJanuary1, 1970,00:00:00GMT. StringCurrentstateofthetask. Taskscanbeinoneofthefollowingstates: A value of...

0 1 2
execState
Indicates that... Thetaskiscurrentlyactive. Thetaskiscurrentlyrunning. Thetaskhasbeensuspendedorhasexpired.
Fortasksthatarescheduledtorunonallserversinthecluster,you mightseedifferentstatusesamongtheparentandchildtasks.For example,theparentsstatusmightbeActive,whileonechildsstatus isActive,andanotherchildsstatusisSuspended. Ingeneral,thestatusoftheparenttaskwillbeActiveifatleastone childtaskisactiveorrunning,Suspendedifallchildtasksare suspended,orExpired,ifallchildtasksareexpired. inputs oneTimeTaskInfo DocumentConditional.Document(IDataobject)containingthe inputs,ifany,tothescheduledservice. DocumentConditional.Informationaboutthecomplextask representedbytaskID.Thisparameterispresentonlyiftypeisonce. Key date time Description StringConditional.Dateonwhichtorunthetask,in yyyy/MM/dd format. StringConditional.Timeatwhichtorunthetask,in HH:mm:ssformat.
406
23 Scheduler Folder
repeatingTaskInfo
DocumentConditional.Informationaboutthetaskrepresentedby taskID.Thisparameterispresentonlyiftypeisrepeat. Key interval doNotOverlap Description StringConditional.Timeinterval(measuredin seconds)betweenrepetitionsofthetask. StringConditional.Indicateswhetherrecurrencesof thistaskwilloverlap.
complexTaskInfo
DocumentConditional.Informationaboutthetask.Thisparameteris presentonlyiftypeiscomplex. Key startDate startTime endDate endTime minutes Description StringConditional.Dateonwhichthetaskis scheduledtostart,inyyyy/MM/dd format. StringConditional.Timeatwhichthetaskis scheduledtostart,inHH:mm:ssformat. StringConditional.Dateonwhichthetaskexpires,in yyyy/MM/ddformat. StringConditional.Timeatwhichthetaskexpires,in HH:mm:ssformat. StringListConditional.Minutesatwhichthetaskis scheduledtorun.Minutesarerepresentedby integersbetween0and59. StringListConditional.Hourswhenthetaskis scheduledtorun.Hoursarerepresentedbyintegers between0and23. StringListConditional.Monthsduringwhichthetask isscheduledtorun.Monthsarerepresentedby integersbetween1and12,where1indicates Januaryand12indicatesDecember. StringListConditional.Daysoftheweekonwhichthe taskisscheduledtorun.Daysarerepresentedby integersbetween1and7,where1indicates Sundayand7indicatesSaturday. StringListConditional.Daysofthemonthonwhich thetaskisscheduledtorun.Daysarerepresentedby integersbetween1and31.
hours
months
daysOfWeek
daysOfMonth
407
23 Scheduler Folder
pub.scheduler:migrateTasksToJDBC
WmPublic.MigratesscheduledusertasksfromtheIntegrationServerembedded databasetoanexternaldatabase. IntegrationServerstoresinformationaboutcertificatemapsandscheduledjobsina databasethatisassociatedwiththeISInternalfunctionalalias.Whenyouinstall IntegrationServer,youcanselectwhetherthisdatabasewillexistasanembedded databasethatisshippedwithIntegrationServer,oranexternalRDBMSthatyousetup.If youchosetousetheembeddeddatabaseatinstalltime,butlaterwanttouseanexternal RDBMSinstead,youcanusethepub.scheduler:migrateTasksToJDBCservicetocopyor moveinformationaboutuserscheduledtasksfromtheembeddeddatabasetothe externalRDBMS. Input Parameters move BooleanSpecifieswhetherthetasksaretobedeletedfromthe embeddeddatabaseafterthemigrationsuccessfullycompletes.Ifset tofalse,thedefault,thetasksremainintheembeddeddatabase.If settotrue,thetasksareremovedfromtheembeddeddatabase.
Output Parameters numberOfTask Migrated successful StringThenumberofuserscheduledtasksthatweremigrated. StringIndicateswhetherornotthemigrationwassuccessful.The servicereturnstrueifalltasksweresuccessfullymigrated, otherwisefalse.
Usage Notes Thisservicecopiesscheduledusertasksonly;itdoesnotcopyormoveinformationabout certificatemaps. BeforerunningthisserviceyoumustinstalltheexternalISInternaldatabasecomponent anddefineadatabaseconnectionforit.Forinstructions,refertothewebMethods InstallationGuide. Whenyouruntheservice,itlooksintheembeddeddatabaseforscheduledusertasks andwritesanytasksitfindstothedatabaseidentifiedbytheISInternalfunctionalalias, whichisdefinedontheSettings>JDBC PoolsscreenoftheIntegrationServer Administrator.
408
23 Scheduler Folder
pub.scheduler:resumeTask
WmPublic.Resumesasuspendedtask. Input Parameters taskID StringIdentificationnumberofthetasktoresume. Ifyourserverrunsaspartofaclusterofservers,andyouhave scheduledatasktorunonallserversinthecluster,notethe followingbeforeresumingatask: Ifyouresumeaparenttask,thetaskwillberesumedonall serversinthecluster. Ifyouresumeachildtask,thetaskwillberesumedonlyonthe serveronwhichthechildtaskwasscheduledtorun. Formoreinformationaboutparentandchildtasks,see pub.scheduler:getTaskInfoonpage 404orthechapterabout managingservicesinthewebMethodsIntegrationServer AdministratorsGuide. Output Parameters taskResumed StringIndicateswhetherthetaskwassuccessfullyresumed.Ifthe taskwassuccessfullyresumed,taskResumedcontainstrue.Ifthetask wasnotsuccessfullyresumed,theserverthrowsanexceptionand terminatestheservice.
409
23 Scheduler Folder
pub.scheduler:suspendTask
WmPublic.SuspendsataskontheScheduler. Input Parameters taskID StringIdentificationnumberofthetasktosuspend. Ifyourserverrunsaspartofaclusterofservers,andyouhave scheduledatasktorunonallserversinthecluster,notethe followingbeforecancelingatask: Ifyoususpendaparenttask,thetaskwillbesuspendedonall serversinthecluster. Ifyoususpendachildtask,thetaskwillbesuspendedonlyon theserveronwhichthechildtaskwasscheduledtorun. Formoreinformationaboutparentandchildtasks,see pub.scheduler:getTaskInfoonpage 404orthechapterabout managingservicesinthewebMethodsIntegrationServer AdministratorsGuide. Output Parameters taskSuspended StringIndicateswhetherthetaskwassuccessfullysuspended.Ifthe taskwassuccessfullysuspended,taskSuspendedcontainstrue.Ifthe taskwasnotsuccessfullysuspended,theserverthrowsanexception andterminatestheservice.
Usage Notes Ifyouwanttocancelataskorremoveataskfromthescheduler,usethe pub.scheduler:cancelTaskservice.
pub.scheduler:updateComplexTask
WmPublic.UpdatesacomplextaskontheScheduler. TheIntegrationServerrunstheserviceforacomplextaskontheday(s)andtime(s)that youspecifyeitherduringaspecifieddaterangeorindefinitely. Input Parameters taskID service description StringIdentificationnumberofthetasktobeupdated. StringOptional.Nameoftheserviceyouwanttoschedulefor executionontheserver. String Optional.Textstringdescribingthistask.
410
23 Scheduler Folder
target
String Optional.Serverorserversonwhichthetaskistorun. (Clusteredenvironmentsonly). Set to...

$any
To... Runthetaskonanyserverinthecluster.Thetask willrunononlyoneoftheservers. Forexample,supposethatalltheserversinyour clustershareasingledatabaseforaparts inventoryapplication,andthataparticular functionneedstorunagainstthatdatabaseoncea day.Anyoftheserverscanperformthistask, thereforeyoucanspecifythe$alloptionto scheduleatasktorunonanyoftheservers. Note: Thereisnopredeterminedorderinwhich serversintheclusterareselectedtoruntasks. Rather,thefirstservertodetectthatataskisready tobeexecutedrunsit. FormoreinformationabouthowIntegration Serverhandlestheschedulingoftasksina clusteredenvironment,seethechapterabout managingservicesinthewebMethodsIntegration ServerAdministratorsGuide.
$all
(Clusteredenvironmentsonly).Runthetaskonall serversinthecluster. Forexample,supposeyourunanapplicationon eachserverinthecluster,andeachserver maintainsitsowndatabaseforthatapplication.If youneedtorunacleanuptaskagainstallthe databaseseveryday,youcanscheduleataskto runeverydayonalltheserversinthecluster. FormoreinformationabouthowIntegration Serverhandlestheschedulingoftasksina clusteredenvironment,seethechapterabout managingservicesinthewebMethodsIntegration ServerAdministratorsGuide.
hostname:port
411
23 Scheduler Folder
lateness
String Optional.Thenumberofminutes(afterthescheduled executiontime)afterwhichtheserveristotakeaspecialactionfora latetask.YouspecifytheactiontobetakeninthelatenessAction parameter,describedbelow.Theserverchecksscheduledtasksat startup,andagainperiodically.Iftheserverfindsataskthatis overdueandhasexceededthelatenessperiod,theserverperforms therequestedlatenessaction.Iftheserverfindsataskthatis overduebuthasnotyetexceededthelatenessperiod,theserver startsthetaskimmediately. String Optional.Actiontotakeifataskhasmisseditsscheduledstart timebyanumberofminutesyouspecifiedwiththelateness parameter.Possibleactionsare: run immediately or 0 Runsthetaskimmediately skip and run at next scheduled interval or 1 Skipsthisexecutionofthetaskandrunsitagainatthenext scheduledruntime. suspend or 2 Placesthetaskinasuspendedstateuntilanadministratorresumes orcancelsthetask.
latenessAction
doNotOverlap
StringOptional.Flagthatindicateswhetheryouwantexecutionsof thistasktooverlap. Set to...

true
To... Preventexecutionsofthescheduledtaskfrom overlapping.Afterascheduledtaskfinishes executing,theSchedulerwaitsthenumberof secondsspecifiedinintervalbeforerunningthe taskagain. Default.Allowexecutionsofthescheduledtaskto overlap.TheSchedulerrunsthetaskeverytime thevalueofintervalelapses.
false
StringOptional.UserIDunderwhichtheserviceistobeexecuted.If youdonotspecifyausername,theDefaultaccessrightsareused. DocumentOptional.Document(IDataobject)containinginputtothe scheduledservice. StringOptional.Timeatwhichthetaskisscheduledtostart,in HH:mm:ssformat.IfyoudonotspecifyastartTime,thecurrenttime isused. StringOptional.Dateonwhichthetaskisscheduledtostart,in yyyy/MM/dd format.Ifyoudonotspecifydate,thecurrentdateis used.
startDate
412
23 Scheduler Folder
endTime endDate
StringOptional.Timeatwhichthetaskexpires,inHH:mm:ssformat. IfyoudonotspecifyanendTime,theserverusesthecurrenttime. StringOptional.Dateonwhichthetaskexpires,inyyyy/MM/dd format.IfyoudonotspecifyanendDate,theserverexecutesthis serviceforanindefiniteperiodoftime. String List Optional.Monthsduringwhichthetaskisscheduledto run.Monthsarerepresentedbyintegersbetween1and12,where 1indicatesJanuaryand12indicatesDecember.Ifyoudonot specifymonths,thetaskwillruneverymonth. String ListOptional.Hoursatwhichthetaskisscheduledtorun. Hoursarerepresentedbyintegersbetween0and23.Ifyoudonot specifyhours,thetaskrunseveryhour. String List Optional.Minutesatwhichthetaskisscheduledtorun. Minutesarerepresentedbyintegersbetween0and59.Ifyoudonot specifyminutes,thetaskrunseveryminute. String List Optional.Daysofthemonthonwhichthetaskis scheduledtorun.Daysarerepresentedbyintegersbetween1and 31.IfyoudonotspecifydaysOfMonth,thetaskrunseverydayofthe month. String List Optional.Daysoftheweekonwhichthetaskisscheduled torun.Daysarerepresentedbyintegersbetween1and7,where1 indicatesSundayand7indicatesSaturday.Ifyoudonotspecify daysOfWeek,thetaskrunseverydayoftheweek.
months
hours
minutes
daysOfMonth
daysOfWeek
Output Parameters type taskUpdated StringCodeindicatingthetypeoftaskthatwasupdated.Forthis typeoftask,thevalueoftypewillbecomplex. StringIndicateswhetherthetaskwassuccessfullyupdated.Ifthe taskwassuccessfullyupdated,taskUpdatedcontainstrue.Ifthetask wasnotsuccessfullyupdated,theserverthrowsanexceptionand terminatestheservice.
Usage Notes Youcanusepub.scheduler:getTaskIDsandpub.scheduler:getTaskInfoservicestoget informationaboutthetaskyouwanttoupdate. Thisserviceupdatesonlythefieldsforwhichyouprovideinputparameters.Ifyou wanttocleartheinformationinanoptionalfield,specifyblanksintheparameterfor thatfield.
413
23 Scheduler Folder
pub.scheduler:updateOneTimeTask
WmPublic.UpdatesaonetimetaskontheScheduler. Input Parameters taskID service description target StringIdentificationnumberofthetasktobeupdated. StringOptional.Nameoftheservicetobescheduled. String Optional.Text string describing this task. String Optional.Server or servers on which the task is to run. (Clustered environmentsonly). Set to...
$any
To... Runthetaskonanyserverinthecluster.Thetask willrunononlyoneoftheservers. Forexample,supposethatalltheserversinyour clustershareasingledatabaseforapartsinventory application,andthataparticularfunctionneedsto runagainstthatdatabaseonceaday.Anyofthe serverscanperformthistask,thereforeyoucan specifythe$alloptiontoscheduleatasktorunon anyoftheservers. Note: Thereisnopredeterminedorderinwhich serversintheclusterareselectedtoruntasks. Rather,thefirstservertodetectthatataskisready tobeexecutedrunsit. FormoreinformationabouthowIntegrationServer handlestheschedulingoftasksinaclustered environment,seethechapteraboutmanaging servicesinthewebMethodsIntegrationServer AdministratorsGuide.
414
23 Scheduler Folder
$all
Runthetaskonallserversinthecluster. Forexample,supposeyourunanapplicationon eachserverinthecluster,andeachservermaintains itsowndatabaseforthatapplication.Ifyouneedto runacleanuptaskagainstallthedatabasesevery day,youcanscheduleatasktoruneverydayonall theserversinthecluster. FormoreinformationabouthowIntegrationServer handlestheschedulingoftasksinaclustered environment,seethechapteraboutmanaging servicesinthewebMethodsIntegrationServer AdministratorsGuide.
hostname:port
lateness
String Optional.Thenumberofminutes(afterthescheduledexecution time)afterwhichtheserveristotakeaspecialactionforalatetask. YouspecifytheactiontobetakeninthelatenessActionparameter, describedbelow.Theserverchecksscheduledtasksatstartup,and againperiodically.Iftheserverfindsataskthatisoverdueandhas exceededthelatenessperiod,theserverperformstherequested latenessaction.Iftheserverfindsataskthatisoverduebuthasnotyet exceededthelatenessperiod,theserverstartsthetaskimmediately. String Optional.Actiontotakeifataskhasmisseditsscheduledstart timebyanumberofminutesyouspecifiedwiththelateness parameter.Possibleactionsare: run immediately or 0 Runsthetaskimmediately skip and run at next scheduled interval or 1 Skipsthisexecutionofthetaskandrunsitagainatthenextscheduled runtime. suspend or 2 Placesthetaskinasuspendedstateuntilanadministratorresumesor cancelsthetask.
latenessAction
runAsUser inputs date time
StringOptional.UserIDunderwhichtheserviceistobeexecuted. DocumentOptional.Document(IDataobject)containinginputstothe scheduledservice. StringOptional.Dateonwhichtorunthetask,inyyyy/MM/ddformat. StringOptional.Timeatwhichtoruntheservice,inHH:mm:ssformat.
415
23 Scheduler Folder
Output Parameters type taskUpdated StringCodeindicatingthetypeoftaskthatwasupdated.Forthis typeoftask,thevalueoftypewillbeonce. StringIndicateswhetherthetaskwassuccessfullyupdated.Ifthe taskwassuccessfullyupdated,taskUpdatedcontainstrue.Ifthetask wasnotsuccessfullyupdated,theserverthrowsanexceptionand terminatestheservice.
Usage Notes Thisserviceupdatesonlythefieldsforwhichyouprovideinputparameters.Ifyou wanttocleartheinformationinanoptionalfield,specifyblanksintheparameterfor thatfield.
pub.scheduler:updateRepeatingTask
WmPublic.UpdatesarepeatingtasktotheScheduler. Input Parameters taskID service description StringIdentificationnumberofthetasktobeupdated. StringOptional.Nameoftheservicerunbythetask. String Optional.Textstringdescribingthistask.
416
23 Scheduler Folder
target
String Optional.Serverorserversintheclusteronwhichthetaskisto run.(Clusteredenvironmentsonly). Set to...

$any
To... Runthetaskonanyserverinthecluster.Thetask willrunononlyoneoftheservers. Forexample,supposethatalltheserversinyour clustershareasingledatabaseforapartsinventory application,andthataparticularfunctionneedsto runagainstthatdatabaseonceaday.Anyofthe serverscanperformthistask,thereforeyoucan specifythe$alloptiontoscheduleatasktorunon anyoftheservers. Note: Thereisnopredeterminedorderinwhich serversintheclusterareselectedtoruntasks. Rather,thefirstservertodetectthatataskisreadyto beexecutedrunsit. FormoreinformationabouthowIntegrationServer handlestheschedulingoftasksinaclustered environment,seethechapteraboutmanaging servicesinthewebMethodsIntegrationServer AdministratorsGuide.
$all
Runthetaskonallserversinthecluster. Forexample,supposeyourunanapplicationon eachserverinthecluster,andeachservermaintains itsowndatabaseforthatapplication.Ifyouneedto runacleanuptaskagainstallthedatabasesevery day,youcanscheduleatasktoruneverydayonall theserversinthecluster. FormoreinformationabouthowIntegrationServer handlestheschedulingoftasksinaclustered environment,seethechapteraboutmanaging servicesinthewebMethodsIntegrationServer AdministratorsGuide.
hostname:port
417
23 Scheduler Folder
lateness
String Optional.Thenumberofminutes(afterthescheduledexecution time)afterwhichtheserveristotakeaspecialactionforalatetask. YouspecifytheactiontobetakeninthelatenessActionparameter, describedbelow.Theserverchecksscheduledtasksatstartup,and againperiodically.Iftheserverfindsataskthatisoverdueandhas exceededthelatenessperiod,theserverperformstherequested latenessaction.Iftheserverfindsataskthatisoverduebuthasnotyet exceededthelatenessperiod,theserverstartsthetaskimmediately. String Optional.Actiontotakeifataskhasmisseditsscheduledstart timebyanumberofminutesyouspecifiedwiththelateness parameter.Possibleactionsare: run immediately or 0 Runsthetaskimmediately skip and run at next scheduled interval or 1 Skipsthisexecutionofthetaskandrunsitagainatthenextscheduled runtime. suspend or 2 Placesthetaskinasuspendedstateuntilanadministratorresumesor cancelsthetask.
latenessAction
runAsUser startTime
StringOptional.UserIDunderwhichtheserviceistobeexecuted.If youdonotspecifyausername,theDefaultaccessrightsareused. StringOptional.Timeatwhichthetaskisscheduledtostart,in HH:mm:ssformat.IfyoudonotspecifyastartTime,thecurrenttimeis used. StringOptional.Dateonwhichthetaskisscheduledtostart,in yyyy/MM/dd format.Ifyoudonotspecifydate,thecurrentdateis used. StringOptional.Timeatwhichthetaskexpires,inHH:mm:ssformat.If youdonotspecifyanendTime,theserverusesthecurrenttime. StringOptional.Dateonwhichthetaskexpires,inyyyy/MM/dd format.IfyoudonotspecifyanendDate,theserverexecutesthis serviceforanindefiniteperiodoftime. DocumentOptional.Document(IDataobject)containinginputstothe scheduledservice. StringOptional.Timeinterval(measuredinseconds)between repetitionsofthetask. StringOptional.Flagindicatingwhetherornotyouwantthe executionsofthistasktooverlap.
startDate
endTime endDate
inputs interval doNotOverlap
418
23 Scheduler Folder
Set to...
true
To... Preventexecutionsofthescheduledtaskfrom overlapping.Afterascheduledtaskfinishes executing,theSchedulerwaitsthenumberof secondsspecifiedinintervalbeforerunningthetask again. Default.Allowexecutionsofthescheduledtaskto overlap.TheSchedulerrunsthetaskeverytimethe valueofintervalelapses.
false
Output Parameters type taskUpdated StringCodeindicatingthetypeoftaskupdated.Forthistypeoftask, thevalueoftypewillberepeat. StringIndicateswhetherthetaskwassuccessfullyupdated.Ifthe taskwassuccessfullyupdated,taskUpdatedcontainstrue.Ifthetask wasnotsuccessfullyupdated,theserverthrowsanexceptionand terminatestheservice.
Usage Notes Thisserviceupdatesonlythefieldsforwhichyouprovideinputparameters.Ifyou wanttocleartheinformationinanoptionalfield,specifyblanksintheparameterfor thatfield.
419
23 Scheduler Folder
420
24
Schema Folder
Youusetheelementsintheschemafoldertovalidateobjectsandtovalidatethepipeline.
421
24 Schema Folder

Thefollowingelementsareavailableinthisfolder: Element pub.schema:createXSD Package and Description WmPublic.CreatesanXMLSchemadefinitionfroma documenttype,fromtheinputandoutputparametersof aservice,orfromaspecification. WmPublic.ValidatesanobjectusinganISdocumenttype oraschema. WmPublic.Validatesthepipelineagainstadocument type. WmPublic.ThisfoldercontainsdefinitionsforXML SchemasasdefinedintheW3CspecificationXML SchemaPart2:Datatypes. WmPublic.AschemacontainingtheXMLNamespace components,suchasxml:langandxml:space,asdefined intheW3CspecificationsNamespacesinXMLand ExtensibleMarkupLanguage(XML)1.0. WmPublic.AschemacontainingtheXMLSchema instancecomponents,suchasxsi:nil, xsi:noNamespaceSchemaLocation,xsi:schemaLocation, andxsi:type,asdefinedintheW3CXMLSchema recommendationPart1:Structures.
pub.schema:validate pub.schema:validatePipeline pub.schema.w3c
pub.schema.w3c:xml
pub.schema.w3c:xsi
pub.schema:createXSD
WmPublic.CreatesanXMLSchemadefinitionfromadocumenttype,fromtheinput andoutputparametersofaservice,orfromaspecification. Input Parameters name StringFullyqualifiednameofadocumenttype,service,or specificationontheIntegrationServer.
422
24 Schema Folder
Output Parameters isSuccessful StringFlagindicatingwhethertheschemadefinitionwascreated successfully. A value of...

true false
Indicates that... Theschemadefinitionwascreatedsuccessfully. Theschemadefinitionwasnotcreated successfully.Seeerrorsfordetailedinformation.
xsd
DocumentConditional.Theschemadefinitionxsdhasthefollowing keys: Key url source Description StringConditional.Relativeurlofthegenerated schema. StringConditional.Schemadefinition.
errors
Document ListConditional.Listoffatalerrors,ifany,thatoccurred whengeneratingtheXSD.Eachdocumentinthelisthasthe followingstructure: Key errorMessage Description StringTextoftheerrormessage.
Whenfatalerrorsoccur,theservicedoesnotgenerateanXSDfile. warnings Document ListConditional.Listofnonfatalerrors,ifany,thatwere encounteredwhilegeneratingtheXSD.Eachdocumentinthelisthas thefollowingstructure: Key warningMessage Description StringTextofthewarningmessage.
Whennonfatalerrorsoccur,theservicegeneratestheXSDfilebut alsoreturnswarningstoindicatethatitencounteredunusualor unexpectedconditionsduringtheprocess. Usage Notes Ifthedocumenttype,servicesignature,orspecificationyouareprovidingasinputto createXSD containsfieldsthatbelongtomultipleXMLnamespaces,createXSDgenerates multipleXMLSchemadefinitions(oneforeachXMLnamespace)andimportsthem intotheXMLSchemacontainedinthesourcefield.TheseimportedXMLSchema definitionsappearaschildrenofxsdinthepipeline.
423
24 Schema Folder
WhenusingcreateXSDtocreateanXMLSchemadefinition,keepthefollowingpoints inmind: Toplevelstringsarenotallowed. Stringtablesbeneaththetoplevelarenotallowed. FieldnamesmustconformtoQNamelexicalrules(thatis,theprefixandlocal namemustconformtoNCNamerulesspecifiedinhttp://www.w3.org/TR/REC xmlnames/#NTNCName). FieldnamescannotcontainaprefixwithoutanassociatedXMLnamespace. Fieldsoftypeotherthanscalarstringcannothavenamesthatbeginwiththe character@orbenamed*body. Fieldsatthesamelevel(thatis,beneaththesameparentfieldintheinputor outputofthesamesignature)canhavethesamenamebutdifferenttypesor properties.However,onlyonefieldstypeandpropertiesisusedforallfields withthatnameatthatlevel.Becausethemethodusedtoselectthefieldisnot defined,Software AGrecommendsavoidingthiscase. Onlyonefieldnamed*bodycanoccuratthesamelevel. Duplicatefieldnamesthatbeginwiththecharacter@cannotrepeatatthesame level. FieldsatdifferentlevelscanhavethesamenamewithduplicateXMLNamespace values,evenifthefieldshavedifferenttypesorproperties.However,onlyone fieldstypeandpropertiesareusedforallfieldswiththatnameatthatlevel. Becausethemethodusedtoselectthefieldisnotdefined,Software AG recommendsavoidingthiscase. Objectconstraintsareallowed.However,theIntegrationServerdoesnot representthemintheXSD. Stringsconstrainedbyolderschematypes(typesdefinedbeforetheW3CXML 2001Schemarecommendations)areallowed.However,theIntegrationServer translatestheminto2001XMLSchematypes. IfyouusecreateXSDtocreatemultipleXMLSchemadefinitionsthatrefertoeach other,placetheXSDfilesinthesamefolderorbasepath.Toensurethatthereferences resolvecorrectly,makesuretherelativeURLsspecifiedintheXSDfilesreflectthe namesoftheXSDfileswithinthisfolderorbasepath.
424
24 Schema Folder
pub.schema:validate
WmPublic.ValidatesanobjectusinganISdocumenttypeoraschema. Input Parameters object conformsTo Documentorcom.wm.lang.xml.Document orcom.wm.lang.xml.NodeObject tobevalidated. StringDocumenttypeorschematovalidateobjectagainst. Ifobjectisadocument(Dataobject),conformsTomustspecifythe fullyqualifiednameofadocumenttypeontheIntegration Server. Ifobjectisacom.wm.lang.xml.Documentor com.wm.lang.xml.Nodeobject,conformsTomustspecifythefully qualifiednameofaschemaontheIntegrationServer. Note: Thespecifiedschemaisusedonlyforvalidatingnodeswith NamesthatarenotfromXMLNamespaces(thatis,qualified nodeswhoseXMLNamespaceNamepropertiesareabsent). maxErrors StringOptional.Numberoferrorstobecollected.Defaultvalueis1. WhenthenumberoferrorsfoundisequaltomaxErrors,the validationprocessorstopsvalidationandreturnstheresult.If maxErrorsissetto-1,thevalidationprocessorreturnsallerrors. StringOptional.Flagthatspecifieswhetherthevalidationprocessor willvalidatecontentkeysofthetypeString,StringList,orString Table. Set to...
true
ignoreContent
To... Ignorecontent(thatis,donotvalidatekeysofthese types). Default.Validatecontent.
false
failIfInvalid
StringOptional.Flagthatindicateswhethertheserviceshouldfail andthrowanexceptioniftheobjectisinvalid. Set to...

true
To... Indicatethattheserviceshouldfailiftheobjectis invalid. Default.Indicatethatserviceshouldsignalsuccess andreturnerrorstothepipelineifobjectisinvalid.
false
425
24 Schema Folder
Output Parameters isValid StringFlagthatindicateswhetherornotthevalidationwas successful. A value of...

true false
Indicates that... Thevalidationwassuccessful. Thevalidationwasunsuccessful.
errors
Document ListErrorsencounteredduringvalidation.Eachdocument willcontainthefollowinginformation: Key pathName errorCode errorMessage Description StringLocationoftheerrorinXQL. StringErrorcode(forexample,VV-001). StringErrormessage(forexample,Missing Object).
pub.schema:validatePipeline
WmPublic.Validatesthepipelineagainstadocumenttype. Input Parameters conformsTo maxErrors StringFullyqualifiednameofthedocumenttypethatyouwantto validateagainst. StringOptional.Numberoferrorstobecollected.Defaultvalueis1. WhenthenumberoferrorsfoundisequaltomaxErrors,the validationprocessorstopsvalidationandreturnstheresult.If maxErrorsissetto-1,thevalidationprocessorreturnsallerrors. StringOptional.Flagthatspecifieswhetherthevalidationprocessor willvalidatecontentkeysofthetypeString,StringList,orString Table. Set to...
true
ignoreContent
To... Ignorecontent(thatis,donotvalidatekeysofthese types). Default.Validatecontent.
false
426
24 Schema Folder
failIfInvalid
StringOptional.Flagthatindicateswhethertheserviceshouldfail andthrowanexceptioniftheobjectisinvalid. Set to...

true false
To... Indicatethatserviceshouldfailifobjectisinvalid. Default.Indicatethatserviceshouldsimplysignal successandreturnerrorstothepipelineifobjectis invalid.
Output Parameters isValid StringFlagthatindicateswhetherornotthevalidationwas successful. A value of...

true false
Indicates that... Thevalidationwassuccessful. Thevalidationwasunsuccessful.
errors
Document ListErrorsencounteredduringvalidation.Eachdocument willcontainthefollowinginformation: Key pathName errorCode errorMessage Description StringLocationoftheerrorinXQL. StringErrorcode(forexample,VV-001). StringErrormessage(forexample,Missing Object).
pub.schema.w3c
WmPublic.ThisfoldercontainsdefinitionsforXMLSchemasasdefinedintheW3C specificationXMLSchemaPart2:Datatypes. Formoreinformationaboutschemasanddatatypes,seethewebMethodsDeveloperUsers GuideandthewebMethodsIntegrationServerSchemaReference.
427
24 Schema Folder
pub.schema.w3c:xml
WmPublic.AschemacontainingtheXMLNamespacecomponents,suchasxml:langand xml:space,asdefinedintheW3CspecificationsNamespacesinXMLandExtensibleMarkup Language(XML)1.0.
pub.schema.w3c:xsi
WmPublic.AschemacontainingtheXMLSchemainstancecomponents,suchasxsi:nil, xsi:noNamespaceSchemaLocation,xsi:schemaLocation,andxsi:type,asdefinedinthe W3CXMLSchemarecommendationPart1:Structures.
428
25
Security Folder
Usetheelementsinthesecurityfolderto: Controlwhichclientcertificatesaresenttootherservices. Digitallysigndata. Processdigitalsignatures. Storeandretrieveoutboundpasswordstoaccesssecureresources. Theservicespub.security:setKeyAndChain,pub.security:setKeyAndChainFromBytes,and pub.security:clearKeyAndChainareusedtocontrolwhichclientcertificatethewebMethods IntegrationServerpresentstoremoteservers.Youneedtousetheseservicestoswitch betweencertificatesandcertificatechainsifyouarenotusingaliasesforremoteservers. Formoreinformationaboutaliasesforremoteservers,seewebMethodsIntegrationServer AdministratorsGuide. Thepub.security.outboundPasswordsservicessupporttheuseofencryptedoutbound passwordstoaccesssecureresources.Youmaywishtohaveaflowserviceaccessa secureresourcesuchasaremoteIntegrationServer,proxyserver,ordatabase.The servicewouldneedtoprovideavalidpasswordtoaccesstheresource.The pub.security.outboundPasswordsservicesallowaflowservicetostorepasswordsinand retrievepasswordsfromtheIntegrationServersoutboundpasswordstore.The outboundpasswordstoreisanencryptedstoreofpasswordsmanagedbytheIntegration Server.Formoreinformationabouttheoutboundpasswordstore,seewebMethods IntegrationServerAdministratorsGuide.
429
25 Security Folder

Thefollowingelementsareavailableinthisfolder: Element pub.security:clearKeyAndChain Package and Description WmPublic.Associatesthedefaultkeyand certificatechainwiththesubsequentset ofinvokedservices. WmPublic.Associatesakeyand certificatechainwiththesubsequentset ofinvokedservices.Usethisserviceto associateakeyandcertificatechainthatis differentfromthedefaultsettings,andif yourkeyandcertificateinformationis locatedinfiles(ratherthanbytearrays). WmPublic.Associatesakeyand certificatechainwiththesubsequentset ofinvokedservices.Usethisserviceto associateakeyandcertificatechainthatis differentfromthedefaultsettings,andif yourkeyandcertificateinformationis locatedinbytearrays(ratherthanfiles). WmPublic.Storesakeyandpasswordin thepasswordstore. WmPublic.Retrievesthepassword associatedwithagivenkey. WmPublic.Liststhekeysinthepassword store. WmPublic.Removesthepassword associatedwithagivenkey. WmPublic.Changesthepassword associatedwithagivenkey. WmPublic.CreatesaPKCS7SignedData object. WmPublic.Processesadigitalsignature tomakesurethattheprovideddatahas notbeenmodified. WmPublic.Generatesamessagedigest foragivenmessage. WmPublic.Retrievesinformationsuchas serialnumber,issuer,andexpirationdate fromadigitalcertificate.
pub.security:setKeyAndChain
pub.security:setKeyAndChainFromBytes
pub.security.outboundPasswords:setPassword pub.security.outboundPasswords:getPassword pub.security.outboundPasswords:listKeys pub.security.outboundPasswords:removePassword pub.security.outboundPasswords:updatePassword pub.security.pkcs7:sign pub.security.pkcs7:verify
pub.security.util:createMessageDigest pub.security.util:getCertificateInfo
430
25 Security Folder
Element pub.security.util:loadPKCS7CertChain
Package and Description WmPublic.Convertsacertificatechain thatisinPKCS#7formattoalistofbyte arrays. WmPublic.ConvertsaJavaString,byte array,orcharacterarraytoa WmSecureString. WmPublic.ConvertsaWmSecureString toaJavaString,bytearray,orcharacter array. WmPublic.DestroysaWmSecureString suchthatitisnolongerinmemoryand removedfromthepipeline.
pub.security.util:createSecureString
pub.security.util:convertSecureString
pub.security.util:destroySecureString
pub.security:clearKeyAndChain
WmPublic.Associatesthedefaultkeyandcertificatechainwiththesubsequentsetof invokedservices. Input Parameters None. Output Parameters None. Usage Notes Thefollowingscenariodescribesasituationinwhichyouwouldusethe pub.security:setKeyAndChainandpub.security:clearKeyAndChainservices. CompanyAhasawebMethodsIntegrationServerwithonecertificatechain. CompanyAwantstostarttradingwithtwonewcompanies:CompanyBand CompanyC.Duetoexplicitbusinessdecisions,bothCompanyBandCompanyC requirethatsecurerequeststotheirserversusecertificatesissuedbytheircompanys certificateauthority.CompanyAnowhasthreecertificatesetsthatitmustmanage: oneforconnectionstoB,oneforconnectionstoC,andoneforallotherrequests. BelowisahighlevelprocessflowofwhatCompanyAwoulddoifdocuments neededtobeforwardedtocompaniesB,C,andD(somearbitrarypartnerwithoutthe stringentsecurity).
431
25 Security Folder
AssumeallnetworkcommunicationisdoneusingHTTPS.Documentsaresenttothe companiesinthefollowingorder:CompanyD,CompanyB,CompanyC,Company D.Alldatatransfersmakeuseofthepub.client:httpservice. 1 2 3 4 5 6 7 Invokepub.client:httptosenddatatoCompanyD. Invokepub.security:setKeyAndChainusingthekeyandcertificatechainfor CompanyB. Invokepub.client:httptosenddatatoCompanyB. Invokepub.security:setKeyAndChainusingthekeyandcertificatechainfor CompanyC. Invokepub.client:httptosenddatatoCompanyC. Invokepub.security:clearKeyAndChaintorevertbacktothedefaultkeyand certificatechainforCompanyAsserver. Invokepub.client:httptosenddatatoCompanyD.
pub.security:setKeyAndChain
WmPublic.Associatesakeyandcertificatechainwiththesubsequentsetofinvoked services.Usethisservicetoassociateakeyandcertificatechainthatisdifferentfromthe defaultsettings,andifyourkeyandcertificateinformationislocatedinfiles(ratherthan bytearrays). Input Parameters privKeyFile StringAbsolute(forexample,D:\certs\cert1.der)orrelativepathof thefilecontainingtheprivatekey.Arelativepathisthepathrelative tothedirectoryfromwhichtheIntegrationServerhasbeenstarted (forexample,IntegrationServer_directory\config\certs\cert1.der). String ListListoffilenamescontainingthecertificatesthatcomprise thecertificatechain.Thelistshouldstartwiththeuserscertificate followedby(inorder)intermediatecertificatesandtherootCA certificate. Absoluteorrelativepathsofthefilescanbespecified. Output Parameters None.
certFiles
432
25 Security Folder
pub.security:setKeyAndChainFromBytes
WmPublic.Associatesakeyandcertificatechainwiththesubsequentsetofinvoked services.Usethisservicetoassociateakeyandcertificatechainthatisdifferentfromthe defaultsettings,andifyourkeyandcertificateinformationislocatedinbytearrays (ratherthanfiles). Input Parameters provoke certs ObjectAbytearraycontainingtheclientsprivatekey. Object ListListofbytearrayscontainingtheclientscertificatechain. Thelistshouldstartwiththeuserscertificatefollowedby(in sequence)intermediatecertificatesandtherootCAcertificate.
Output Parameters None. Usage Notes ToenablethisservicetoworkproperlyifyouusetheFTPSprotocol,youmustsetthe secureparametertoTrueinthepub.client:httpandpub.client.ftp:loginservices. Youcanusepub.security:clearKeyAndChainwithpub.security:setKeyAndChainFromBytes.Seethe UsageNotesforpub.security:clearKeyAndChainformoreinformationaboutusingthe pub.security:setKeyAndChainFromBytesservice.
pub.security.outboundPasswords:setPassword
WmPublic.Storesakeyandpasswordinthepasswordstore. Input Parameters key value isInternal StringKeytobeassociatedwiththepasswordentry. WmSecureString Passwordtobestored. Stringtrueifthisshouldbesavedasaninternalpassword;false ifitshouldbesavedasapublicpassword.Defaultisfalse.(See InternalandPublicPasswordsformoreinformation.)
Output Parameters result message Stringtrueifpasswordwassuccessfullystored;falseotherwise. String successfulorreasonforfailure.
433
25 Security Folder
Usage Notes Thisisthebasicprocessaflowserviceshouldfollowtostoreanoutboundpassword: 1 Callpub.security.util:createSecureStringtocreateaWmSecureStringobject containingthepasswordtobestored. Forsecurityreasons,theflowserviceshouldberunmanuallyrequiringan authorizedpersontotypethepasswordtobestored.Thiswilleliminatethe needtosavethepasswordondiskinanunencryptedformat. 2 Callpub.security.outboundPasswords:setPasswordtosavethepasswordinencrypted formintheoutboundpasswordstore. Thepub.security.outboundPasswords:setPasswordservicerequiresakeytobe suppliedwhichisbasicallyakeytothepassword.Thiskeymustbesavedin someway;anyflowservicewishingtousethepasswordtoaccessasecure resourcewillneedtosupplythekeytoretrievethepasswordfromthe outboundpasswordstore. 3 Oncethepasswordissuccessfullystored,callpub.security.util:destroySecureString toremovethepasswordfrommemory.
Internal and Public Passwords InternalpasswordsarepasswordsforusebytheIntegrationServeritselftoaccesssecure resources(e.g.,remoteIntegrationServers,JDBCconnectionpools,LDAPservers,etc.). InternalpasswordsaremanagedusingtheIntegrationServerAdministratorandare storedintheoutboundpasswordstore.Flowservicesarealsoallowedtostorepasswords intheoutboundpasswordstore.However,bydefault,passwordsstoredbyaflowservice areconsideredpublic,asopposedtointernal.Thisdistinctionallowsflowservicesto usetheoutboundpasswordstoreasasecuremechanismforstoringandretrieving passwords,butprotectstheIntegrationServersinternalpasswords. Whencallinganyofthepub.security.outboundPasswordsservices(i.e.setPassword, getPassword,listKeys,removePassword,andupdatePassword)theisInternalinput parameterindicateswhethertheserviceisworkingwithinternalorpublicpasswords. Notethatevenifthisparameterissettotrue,youcannotaccessinternalpasswordsif theIntegrationServerisconfiguredtodenyaccesstointernalpasswords.Accessto internalpasswordsiscontrolledbythewatt.security.ope.AllowInternalPasswordAccess configurationparameterontheIntegrationServer;formoreinformationseewebMethods IntegrationServerAdministratorsGuide.
434
25 Security Folder
pub.security.outboundPasswords:getPassword
WmPublic.Retrievesapasswordfromthepasswordstoreforagivenkey. Input Parameters key isInternal StringKeyofthepasswordentrytoberetrieved. Stringtrueifthisisaninternalpassword;falseifitispublic.By default,thisisfalse.Ifyouspecifyincorrectlywhetherthe passwordisinternalorpublic,theretrieveoperationwillfail.(For moreinformationaboutinternalandpublicpasswords,seeInternal andPublicPasswords.)
Output Parameters value result message Usage Notes Thisisthebasicprocessaflowserviceshouldfollowtoretrieveanoutboundpassword: 1 Callpub.security.outboundPasswords:getPasswordwiththekeytothepasswordtobe retrieved. Ifthekeyisunknown,youcancallpub.security.outboundPasswords:listKeysto retrievealistofkeyscurrentlyintheoutboundpasswordstore. Thepub.security.outboundPasswords:getPasswordservicereturnsaWmSecureString objectcontainingtheretrievedpassword. 2 Callpub.security.util:convertSecureStringtoconvertthepasswordtoausable format. Thepasswordcanthenbepassedtotheauthenticatingmechanismofthe secureresource. 3 Whendoneaccessingthesecureresource,callpub.security.util:destroySecureString toremovethepasswordfrommemory. WmSecureStringValueoftheretrievedpassword. String trueifthepasswordvaluewassuccessfullyretrieved; falseotherwise. Stringsuccessfulorreasonforfailure.
435
25 Security Folder
pub.security.outboundPasswords:listKeys
WmPublic.Liststhekeysinthepasswordstore. Input Parameters isInternal Stringtrueifyouwantkeysforinternalpasswords;falseifyou wantkeysforpublicpasswords.Bydefaultthisisfalse.(Formore informationaboutinternalandpublicpasswords,seeInternaland PublicPasswords.)
Output Parameters key result IDataListofkeysinthepasswordstore. Stringtrueifthelistofkeyswassuccessfullyretrieved;false otherwise.
pub.security.outboundPasswords:removePassword
WmPublic.Removesapasswordfromthepasswordstoreforagivenkey. Input Parameters key isInternal StringKeyofthepasswordtoberemoved. Stringtrueifthisisaninternalpassword;falseifitispublic.By default,thisisfalse.Ifyouspecifyincorrectlywhetherthe passwordisinternalorpublic,theremoveoperationwillfail.(For moreinformationaboutinternalandpublicpasswords,seeInternal andPublicPasswords.)
Output Parameters result message Stringtrueifthepasswordwassuccessfullyremoved;false otherwise. Stringsuccessfulorreasonforfailure.
436
25 Security Folder
pub.security.outboundPasswords:updatePassword
WmPublic.Changesthepasswordvalueforakeyalreadyinthepasswordstore. Input Parameters key newPassword isInternal StringKeyofthepasswordtobeupdated. WmSecureStringNewpasswordvalueforthekey. Stringtrueifthisisaninternalpassword;falseifitispublic.By default,thisisfalse.Ifyouspecifyincorrectlywhetherthe passwordisinternalorpublic,theupdateoperationwillfail.(For moreinformationaboutinternalandpublicpasswords,seeInternal andPublicPasswords.)
Output Parameters result message Stringtrueifthepasswordvaluewassuccessfullychanged;false otherwise. Stringsuccessfulorreasonforfailure.
pub.security.pkcs7:sign
WmPublic.CreatesaPKCS7SignedDataobject. Thisserviceenablesmultipleentitiestosignthespecifieddata.EachsignerInfoblock containedintheresultingsignaturecontainstwoauthenticatedattributes:thecontent typeandatimestamp. Input Parameters signerInfo Document List Informationaboutasinglesignerofthesigneddata object.EachsignerInforequireseitheracertificatechainanda privatekeyorakeyaliasthatreferencesthem. Key certChain Description java.security.cert.X509Certificate[ ]orbyte[ ][ ] Certificatechainofthesigner.Thesubjectthatis performingthesignatureshouldbethefirst certificateinthischain,whiletherootCertifying Authorityshouldbethelast.Thekeyprovided shouldcorrespondtothepublickeycontainedin thefirstcertificateofthechain.
437
25 Security Folder
key
java.security.PrivateKeyorbyte[ ]Privatekeythat willbeusedtodigitallysignthedata.Theprivate keycanbeanyasymmetricencryptionkeythatis supportedbythewebMethodsIntegrationServer (forexample,DSAorRSA). StringAliasofthecertificatechainandprivate keyinthekeystore.Thiskeyisnotcurrently used. StringThealgorithmtousewhencomputingthe digestoftheprovideddata(SHA1orMD5).The defaultvalueisMD5.
keyAlias
hashAlgorithm
data detachedSignature
byte[ ] Datatobedigitallysigned. StringFlagspecifyingwhethertogenerateadetachedsignature.A detachedsignaturedoesnotincludethedatathatwassigned. Set to...

true false
To... Generateadetachedsignature. Default.Generateanimplicitsignature(onethat includesthesigneddata).
Output Parameters signature byte[ ]Signaturegeneratedfromthesupplieddata.ThisisaDER encodedrepresentationoftheSignedDataobjectasspecifiedin PKCS#7.
pub.security.pkcs7:verify
WmPublic.Processesadigitalsignaturetomakesurethattheprovideddatahasnot beenmodified. Input Parameters signature byte[ ] Signaturetousetodeterminewhetherthesigneddatais intact(aDERencodedrepresentationoftheSignedDataobjectas specifiedinPKCS#7).Ifyouareprocessingadetachedsignature, passthesignatureinsignature.Ifyouareprocessinganimplicit signature,passtheentiresignedmessageinsignature. byte[ ]Optional.Thedatathatwassigned.Ifyouareprocessinga detachedsignature,youmustsupplydata.Ifyouareprocessingan implicitlysignedmessage,youdonotneedtosupplydatabecause boththemessageandthesignatureresideinsignature.
data
438
25 Security Folder
detachedSignature
StringOptional.Flagindicatingwhetherthemessagehasa detachedsignature. Set to...

true false
When... Themessagehasadetachedsignature. Default.Themessagehasanimplicitsignature.
signerCertChain
byte[ ][ ] Optional.Certificatechainsofthepartiesthatsignedthe message. Note: Ifthesignersincludedthecertificatechainwiththedigital signature,youdonotneedtosupplysignerCertChain.
Output Parameters content byte[ ] Conditional.Thedata(forexample,thedocumentthatwas originallysigned)extractedfromanimplicitsignature.Ifyouare verifyingadetachedsignature,contentisnotreturned. Note: Theextracteddataisreturnedincontentevenifsignature verificationfails. signerInfo Document List Informationaboutthesigners.Eachdocumentinthe listprovidesthefollowinginformationaboutasinglesigner: Key certChain Description java.security.cert.X509Certificate[] Certificatechainofthe signer.Thechainwillappearinhierarchicalorder, startingwiththesignersX.509certificateinelement0. java.util.Date Timeatwhichthesignersignedthedata. String Flagindicatingwhetherthecertificatechain presentedbythesigneristrusted. A value of...
true false
timeStamp trusted
Indicates that... Thechainistrusted. Thechainisnottrusted.
status
String Flagindicatingwhetherthesignatureswere successfullyverified.Ifsuccessful,statuscontains verified.Ifthesignatureswerenotsuccessfully verified,statuscontainsanerrormessage.
439
25 Security Folder
pub.security.util:createMessageDigest
WmPublic.Generatesamessagedigestforagivenmessage. Input Parameters algorithm input Output Parameters output byte[ ]Computeddigest. StringNameofthealgorithmthatyouwanttousetocomputethe messagedigest.MustbeeitherMD5orSHA-1. byte[ ]Messageforwhichyouwantthedigestgenerated.
pub.security.util:getCertificateInfo
WmPublic.Retrievesinformationsuchasserialnumber,issuer,andexpirationdatefrom adigitalcertificate. Input Parameters certificate Output Parameters info Document Informationfromthecertificate. Key version serialNumber signature issuer Description java.lang.Number X509certificateversion number. String Serialnumberofthecertificate. String Signaturealgorithmusedbytheissuer tosignthiscertificate. Document DetailedinformationabouttheCA thatsignedthecertificate,suchasname, location,andemailaddress. byte[] java.security.cert.X509CertificateThecertificatewhose informationyouwanttoretrieve.
440
25 Security Folder
validity
Document Thetimeperiodoverwhichthe certificateisvalid. Key notBefore Description StringFirstdateonwhichthis certificateisvalid(forexample, 3/15/003:36PM). StringLastdateonwhichthis certificateisvalid(forexample, 3/15/003:36PM).
notAfter
subject
DocumentDetailedinformationaboutthe ownerofthecertificate,suchasname, location,andmailaddress.
subjectPublicKeyAlgorithm StringEncryptionalgorithmwithwhichthe certificateskeyisdesignedtobeused(for example,RSAorDSA).
pub.security.util:loadPKCS7CertChain
WmPublic.ConvertsacertificatechainthatisinPKCS#7formattoalistofbytearrays. Input Parameters certificateChain Output Parameters certificates byte[ ] [ ] Listofbytearraysinwhicheachbyte[]inthelistcontainsa certificatefromcertificateChain. byte[ ] ThecertificatechaininPKCS#7format.
pub.security.util:createSecureString
WmPublic.CreatesaWmSecureStringobjectfromeitheraJavaString,bytearray,or characterarray. WmSecureStringisamutablealternativetoJavaString.Itallowsthecharactersinthe stringtobeexplicitlyremovedfrommemory.Anypasswordyouwishtostoreinthe IntegrationServersoutboundpasswordstoremustbeconvertedtoaWmSecureString. Input Parameters string bytes StringJavaStringtomadeintoaWmSecureString. byte[ ]BytearraytobemadeintoaWmSecureString.
441
25 Security Folder
chars encoding
char[ ]CharacterarraytobemadeintoaWmSecureString. StringIfabytearrayissuppliedasaninputparameter,encoding specifiestheJavaencodingofthebytearray.Thismaybeany encodingsupportedbyJavaString.Bydefault,ifnoencodingis specified,thenthedefaultJVMencodingisused.
Output Parameters secureString Usage Notes Onlyoneoftheinputparameters(i.e.string,bytes,orchars)maybespecified.Ifmore thanoneisspecified,anexceptionwillbethrown.Anexceptionisalsothrownifnone oftheseisspecified. WmSecureStringWmSecureStringcreatedfromthesupplied inputparameters.
pub.security.util:convertSecureString
WmPublic.ReturnsaWmSecureStringinJavaString,bytearray,orcharacterarray format. Input Parameters secureString returnAs WmSecureStringWmSecureStringtobeconverted. StringFormatintowhichtheWmSecureStringistobeconverted. Validoptionsarebyte[],char[],andJavaString.Ifavalueforthis parameterisnotspecified,thedefaultistoconvertthe WmSecureStringtoaString.
Output Parameters string bytes chars StringTheWmSecureStringconvertedtoaJavaString. byte[ ]TheWmSecureStringconvertedtoanativeJavabyte array. char[ ]TheWmSecureStringconvertedtoanativeJavacharacter array.
442
25 Security Folder
pub.security.util:destroySecureString
WmPublic.DestroysaWmSecureStringsuchthatitnolongerresidesinmemoryandis removedfromthepipeline. Input Parameters secureString Output Parameters None. WmSecureStringWmSecureStringtobedestroyed.
443
25 Security Folder
444
26
SMIME Folder
Youusetheelementsinthesmimefoldertocreatedigitallysignedand/orencrypted MIMEmessages.Youalsousetheservicesinthisfoldertoprocesssignedandencrypted MIMEmessagesthatarepassedintothepipeline.
445
26 SMIME Folder

Thefollowingelementsareavailableinthisfolder: Element pub.smime:createCertsOnlyData pub.smime:createEncryptedData pub.smime:createSignedAndEncryptedData pub.smime:createSignedData pub.smime:processCertsOnlyData pub.smime:processEncryptedData pub.smime:processSignedData Package and Description WmPublic.GeneratesaPKCS#7certsonly S/MIMEentityfromanarrayofcertificates. WmPublic.EncryptsaMIMEmessage. WmPublic.DigitallysignsaMIMEmessage andthenencryptsit. WmPublic.DigitallysignsaMIMEmessage. WmPublic.Extractsthecertificatesfroma PKCS#7certsonlyS/MIMEentity. WmPublic.DecryptsanencryptedS/MIME message. WmPublic.Verifiesthesignaturefroma signedS/MIMEentityandextractsthe messagefromit.
pub.smime:createCertsOnlyData
WmPublic.GeneratesaPKCS#7certsonlyS/MIMEentityfromanarrayofcertificates. Thisservicecanbeusedtodevelopmechanismsfortransmittingcertificatesand certificatechainstootherparties. Input Parameters certificates Output Parameters SMimeEnvStream Usage Notes ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. java.io.InputStreamS/MIMEentity. byte[ ][ ] Thecertificatesthataretobeencapsulatedwithinthe S/MIMEentity.Eachbyte[]representsasinglecertificate.
446
26 SMIME Folder
pub.smime:createEncryptedData
WmPublic.EncryptsaMIMEmessage. Input Parameters envStream recipientCerts java.io.InputStreamMIMEmessagethatyouwanttoencrypt(for example,theoutputproducedbypub.mime:getEnvelopeStream). byte[ ][ ]TheX.509certificatesoftherecipientsforwhomthis messagewillbeencrypted.Eachelementinthelistrepresentsa certificateforasinglerecipientintheformofabyte[]. Note: Whenyouhavemultiplerecipients,createEncryptedDatacreates asinglemessagethatisencryptedforallrecipients.Itdoesnot createaseparatemessageforeachrecipient. encryptionAlg keyLength StringOptional.Codespecifyingtheencryptionalgorithmtouse. MustbeTripleDES(default),DES,orRC2. StringOptional.LengthoftheencryptionkeyforRC2encryption. Mustbe40,64,or128(default). ThisparameterisignoredifencryptionAlgisnotRC2. Output Parameters SMimeEnvStream Usage Notes ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. See Also pub.smime:createSignedData pub.smime:processEncryptedData pub.mime:getEnvelopeStream Examples SeethefollowingintheWmSamplespackageinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.smime:build_EncryptedSMime java.io.InputStreamTheencryptedMIMEmessage.
447
26 SMIME Folder
pub.smime:createSignedAndEncryptedData
WmPublic.DigitallysignsaMIMEmessageandthenencryptsit. Important! Youmustusethisservicewhenyouwanttocreateamessagethatisboth signedandencrypted.Youcannotproducethistypeofmessageusingthe pub.smime:createSignedDataandpub.smime:createEncryptedDataservices. Input Parameters envStream java.io.InputStreamTheMIMEmessagethatyouwanttosignand encrypt(forexample,theoutputproducedby pub.mime:getEnvelopeStream). byte[ ]Privatekeyofthepartysigningthemessage. byte[ ] [ ] Optional.Thecertificatechainofthepartysigningthe message,whereeachbyte[]representsasinglecertificateinthe chain.Certificatesmustappearinhierarchicalorder,startingwith thesignerscertificateinelement0.Thefollowinglistshowshow theelementsofacompletechainwouldappearforacertificatethat wasissuedthroughtwointermediateCAs: Element
0 1 2 3
privKey certificates
Contents Signerscertificate. IntermediaryCACertificate. IntermediaryCACertificate. RootCACertificate.
Note: Althoughthisparameterisoptional,itshouldonlybeomitted ifthepartyreceivingthemessageisabletoprocessthissignature withoutanaccompanyingcertificatechain. signerCert explicit byte[ ]Digitalcertificateofthepartysigningthemessage. StringOptional.Flagindicatingwhetheranimplicitorexplicit signatureistobegenerated. Set to...
true false
recipientCerts
byte[ ][ ] X.509certificatesoftherecipientsforwhomthismessage willbeencrypted.Eachelementinthelistcontainsthecertificatefor asinglerecipientintheformofabytearray.
448
26 SMIME Folder
encryptionAlg keyLength
StringOptional.Codespecifyingtheencryptionalgorithmtouse. MustbeTripleDES(default),DES,orRC2. StringOptional.LengthoftheencryptionkeyforRC2encryption. Mustbe40,64,or128(default). ThisparameterisignoredifencryptionAlgisnotRC2.
Output Parameters SMimeEnvStream Usage Notes ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. See Also pub.smime:createEncryptedData pub.smime:processEncryptedData pub.smime:createSignedData pub.smime:processSignedData pub.mime:getEnvelopeStream Examples SeethefollowingintheWmSamplespackageinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.smime:build_SignedAndEncryptedSMime java.io.InputStreamSignedandencryptedMIMEmessage.
pub.smime:createSignedData
WmPublic.DigitallysignsaMIMEmessage. Input Parameters envStream privKey java.io.InputStreamMIMEmessagethatyouwanttosign(for example,theoutputproducedbypub.mime:getEnvelopeStream). byte[] Privatekeyofthepartysigningthemessage.
449
26 SMIME Folder
certificates
byte[ ][ ]Optional.Certificatechainofthepartythatsignedthe message,whereeachbyte[]representsasinglecertificateinthe chain.Certificatesmustappearinhierarchicalorder,startingwith thesignerscertificateinelement0.Thefollowingshowshowthe elementsofacompletechainwouldappearforacertificatethat wasissuedthroughtwointermediateCAs: Element

0 1 2 3
Althoughthisparameterisoptional,itshouldonlybeomittedif thepartyreceivingthemessageisabletoprocessthissignature withoutanaccompanyingcertificatechain. signerCert explicit byte[ ] Digitalcertificateofthepartysigningthemessage. StringOptional.Flagindicatingwhetheranimplicitorexplicit signatureisgenerated. Set to...
true false
Output Parameters SMimeEnvStream Usage Notes ForgeneralinformationaboutMIMEmessagesandusingtheMIMEservices,seethe MIMES/MIMEDevelopersGuide. See Also pub.smime:createEncryptedData pub.mime:getEnvelopeStream Examples SeethefollowingintheWmSamplespackageinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.smime:build_SignedSMime java.io.InputStreamThesignedMIMEmessage.
450
26 SMIME Folder
pub.smime:processCertsOnlyData
WmPublic.ExtractsthecertificatesfromaPKCS#7certsonlyS/MIMEentity. Input Parameters SMimeEnvStream Output Parameters certificates byte[ ][ ] Theextractedcertificates.Eachelementinthelistcontains oneoftheextractedcertificatesrepresentedasabyte[]. java.io.InputStreamThecertsonlyS/MIMEentity.
pub.smime:processEncryptedData
WmPublic.DecryptsanencryptedS/MIMEmessage. Input Parameters SMimeEnvStream recipientCert privKey Output Parameters mimeData contentDigest DocumentMIMEobjectcontainingthedecryptedMIMEmessage. StringMessagedigestoftheencryptedcontent,base64encoded. (Somesitesreturnthisdigesttothesendertoacknowledgetheir receiptofthemessage.) StringConditional.FlagindicatingwhetherthedecryptedMIME entityisencrypted. A value of...
true false
java.io.InputStreamTheencryptedS/MIMEentity(forexample,the outputproducedbypub.smime:createEncryptedData). byte[ ]Digitalcertificateofthepartyreceivingthemessage. byte[ ]Privatekeyofthepartyreceivingthemessage(thatis,the partywhosepublickeywasusedtoencryptthemessage).
encrypted
signed
StringConditional.FlagindicatingwhetherthedecryptedMIME entityissigned. A value of...

true false
451
26 SMIME Folder
certsOnly
StringConditional.FlagindicatingwhetherthedecryptedMIME entityisacertsonlyentity. A value of...

true false
stream Usage Notes
java.io.InputStreamConditional.ThedecryptedMIMEentity.
Ifthedecryptedmessageissignedorencrypted,mimeDatawillbeempty,andthe decryptedmessagewillresideinstream.Youcancheckthestateofthesignedand encryptedoutputvariablestodeterminewhetherthedecryptedmessagerequires additionalprocessing,andpassstreamtothepub.smime:processSignedDataor pub.smime:processEncryptedDataserviceasnecessary. Important! YoucanexaminethecontentsofmimeDataduringtestingand debugging.However,becausetheinternalstructureofmimeDataissubjectto changewithoutnotice,do notexplicitlysetormapdatato/fromtheseelementsin yourservice.TomanipulateoraccessthecontentsofmimeData,useonlytheMIME servicesthatIntegrationServerprovides. See Also pub.smime:processSignedData pub.smime:createEncryptedData Examples SeethefollowingintheWmSamplespackagesinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.smime:extract_EncryptedSMime sample.smime:extract_SignedAndEncryptedSMime
452
26 SMIME Folder
pub.smime:processSignedData
WmPublic.VerifiesthesignaturefromasignedS/MIMEentityandextractsthemessage fromit. Input Parameters SMimeEnvStream signerCertChain java.io.InputStreamSignedMIMEentity(forexample,theoutput producedbypub.smime:createSignedData). byte[ ][ ]Optional.Certificatechainofthepartythatsignedthe message,whereeachbyte[]representsasinglecertificateinthe chain.Certificatesmustappearinhierarchicalorder,startingwith thesignerscertificateinelement0.Thefollowingshowshowthe elementsofacompletechainwouldappearforacertificatethat wasissuedthroughtwointermediateCAs: Element
0 1 2 3
Note: Ifthesignerincludedthecertificatechainwiththedigital signature,youdonotneedtosupplysignerCertChain. Output Parameters mimeData contentDigest signerCert encrypted DocumentMIMEobjectcontainingtheextractedMIMEentity. StringMessagedigest(base64encoded)thatwasrecalculatedby processSignedData. java.security.cert.X509CertificateSignersX.509certificate. StringConditional.FlagindicatingwhethertheextractedMIME entityisencrypted. A value of...
true false
453
26 SMIME Folder
signed
StringConditional.FlagindicatingwhethertheextractedMIME entityissigned. A value of...

true false
certsOnly
StringConditional.FlagindicatingwhethertheextractedMIME entityisacertsonlyentity. A value of...

true false
stream verify
java.io.InputStreamConditional.ExtractedMIMEentity. StringFlagindicatingwhetherthesignaturewassuccessfully processed.Successindicatesthatthesignaturewassuccessfully verifiedwiththesuppliedpublickey. A value of...

true false
Indicates that... Signatureprocessingwassuccessful. Signatureprocessingfailed.Thesignaturecouldnot beverifiedbecauseanerrorCode1,2,3,or4occurred. Indicates that... Thesignercertificateistrusted. Thesignercertificateisnottrusted.
trusted
StringFlagindicatingwhetherthesignercertificateistrustedornot. A value of...

true false
errorCode
StringConditional.Numberindicatingthekindoferrorthat occurredwhileprocessingthesignature.SeeerrorMessagefor possiblevalues. Ifnoerroroccurred,errorCodewillnotbereturned. StringConditional.Textualerrormessageindicatingwhatkindof erroroccurredwhileprocessingthesignature.Errorcodesand messagesareasfollows: errorCode

1 2 3
errorMessage
errorMessage
Invalid signer certificate file information. Certificate at index i is not in recognizable format. Invalid certificate input at index i.
454
26 SMIME Folder
4 5 6 7
Signature cannot be verified. Expired certificate chain. Error in certificate chain. Untrusted certificate.
Usage Notes Ifverifyisfalse,theerrorCodeanderrorMessagevalueswillindicatetheerrorthat causedthefailure.NotethaterrorCodevalues5through7donotrepresentsignature validationfailuresand,therefore,donotcausetheverifyflagtobesettofalse. Iftheextractedentityissignedorencrypted,mimeDatawillbeempty,andthe extractedentitywillresideinstream.Youcancheckthestateofthesignedand encryptedoutputvariablestodeterminewhethertheextractedentityrequires additionalprocessing,andpassstreamtothepub.smime:processEncryptedDataserviceas necessary. Important! YoucanexaminethecontentsofmimeDataduringtestingand debugging.However,becausetheinternalstructureofmimeDataissubjectto changewithoutnotice,do notexplicitlysetormapdatato/fromtheseelementsin yourservice.TomanipulateoraccessthecontentsofmimeData,useonlytheMIME servicesthatIntegrationServerprovides. See Also pub.smime:processEncryptedData pub.smime:createSignedData Examples SeethefollowingintheWmSamplespackagesinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.smime:extract_SignedSMime sample.smime:extract_SignedAndEncryptedSMime
455
26 SMIME Folder
456
27
SOAP Folder
YouusetheelementsinthesoapfoldertocomposeandsendSOAPmessagesandto receiveandretrievedatafromwithinthem.YoualsouseSOAPservicestoregister customSOAPprocessors.
457
27 SOAP Folder

Thefollowingelementsareavailableinthisfolder: Element pub.soap.handler:listConsumer Package and Description WmPublic.Returnsalistoftheconsumer handlersthatarecurrentlyregisteredonthe IntegrationServer. WmPublic.Returnsalistoftheprovider handlersthatarecurrentlyregisteredonthe IntegrationServer. WmPublic.Registersthehandlerforthe consumerWebservicedescriptor. WmPublic.Registersthehandlerforthe providerWebservicedescriptor. WmPublic.Unregistersthehandlerforthe consumerWebservicedescriptor. WmPublic.Unregistersthehandlerforthe providerWebservicedescriptor. WmPublic.ReturnsalistoftheSOAP processorsthatarecurrentlyregisteredonthe IntegrationServer. WmPublic.ExecutestheIntegrationServers defaultSOAPprocessor. WmPublic.ExecutestheIntegrationServers SOAPRPCprocessor. WmPublic.RegistersaserviceasaSOAP processorontheIntegrationServer. WmPublic.UnregistersaSOAPprocessorby removingitfromtheregistry. WmPublic.Schemathatdefinesthedatatypes SOAPsupports. WmPublic.Schemathatdefinesthestructureof aSOAPmessage. WmPublic.Insertsanentryintothebody elementofaSOAPmessage. WmPublic.Insertsanentryintotheheader elementofaSOAPmessage. WmPublic.InsertsatrailerinaSOAPmessage.
pub.soap.handler:listProvider
pub.soap.handler:registerConsumer pub.soap.handler:registerProvider pub.soap.handler:unregisterConsumer pub.soap.handler:unregisterProvider pub.soap.processor:list
pub.soap.processor:processMessage pub.soap.processor:processRPCMessage pub.soap.processor:registerProcessor pub.soap.processor:unregisterProcessor pub.soap.schema:encoding pub.soap.schema:envelope pub.soap.utils:addBodyEntry pub.soap.utils:addHeaderEntry pub.soap.utils:addTrailer
458
27 SOAP Folder
Element pub.soap.utils:createSoapData pub.soap.utils:exitUnableToUnderstand pub.soap.utils:getActor
Package and Description WmPublic.CreatesanemptySOAPobject. WmPublic.Terminatesprocessingandreturns amustUnderstandfaulttotheclient. WmPublic.Retrievesthevalueoftheactor attribute(forSOAP1.1)ortheroleattribute(for SOAP1.2)fromagivenheaderentry. WmPublic.RetrievesthebodyfromaSOAP messageasasinglenodeobject. WmPublic.Retrievesthebodyentriesfroma SOAPmessageasanarrayofnodeobjects. WmPublic.RetrievesanentireSOAPmessage asanodeobject. WmPublic.RetrievestheheaderfromaSOAP messageasasinglenodeobject. WmPublic.Retrievestheheaderentriesfroma SOAPmessageasanarrayofnodeobjects. WmPublic.ReturnsthemustUnderstandstatus foragivenheaderentry. WmPublic.Returnsthequalifiednamefora givennode. WmPublic.RetrievesthetrailersfromaSOAP message. WmPublic.Documenttypethatdefinesthe structureofaqualifiedname. WmPublic.DeletesabodyentryfromaSOAP message. WmPublic.Deletesaheaderentryfroma SOAPmessage. WmPublic.DeletesatrailerfromaSOAP message. WmPublic.Definestheinput/outputsignature foracustomprocessorandatargetservicefor thedefaultprocessor. WmPublic.Returnstheeffectivepolicyfora handlerinaWebservicedescriptortothe policysetinthePolicynamepropertyin webMethodsDeveloper.
pub.soap.utils:getBody pub.soap.utils:getBodyEntries pub.soap.utils:getDocument pub.soap.utils:getHeader pub.soap.utils:getHeaderEntries pub.soap.utils:getMustUnderstand pub.soap.utils:getQName pub.soap.utils:getTrailers pub.soap.utils:QName pub.soap.utils:removeBodyEntry pub.soap.utils:removeHeaderEntry pub.soap.utils:removeTrailer pub.soap.utils:requestResponseSpec
pub.soap.utils:resetWSDEffectivePolicy
459
27 SOAP Folder
Element pub.soap.utils.setWSDEffectivePolicy pub.soap.utils:soapDataToString pub.soap.utils:streamToSoapData pub.soap.utils:stringToSoapData pub.soap.utils:validateSoapData
Package and Description WmPublic.Setstheeffectivepolicyfora handlerinaWebservicedescriptor. WmPublic.ConvertsaSOAPobjecttoaString. WmPublic.ConvertsanInputStream containingaSOAPmessagetoaSOAPobject. WmPublic.ConvertsaStringcontaininga SOAPmessagetoaSOAPobject. WmPublic.VerifiesthataSOAPobject representsavalidSOAPmessage.
pub.soap.handler:listConsumer
WmPublic.Returnsalistoftheconsumerhandlersthatarecurrentlyregisteredonthe IntegrationServer. Input Parameters None. Output Parameters Handlers String Optional.ValuetowhichyouwantthemustUnderstand attributeset. ThemustUnderstandattributespecifieswhetherrecipientsare requiredtoprocessaheaderentry(thatis,whetherprocessingofthe entryismandatoryoroptional).Recipientsthatcannotprocessa mandatoryheaderentrymustrejectthemessageandreturnaSOAP fault. Key descriptiveName className policyType Description String Optional.Descriptivenamegiventothe SOAPconsumerhandlerwhenitwasregistered. String Classnameofthehandler. String Policytypeofthehandler.
460
27 SOAP Folder
Headers
Document List Listofavailableconsumerheaders. Key namespace localName Description String Namespaceportionofthe headersqualifiedname. String Localportionofthe headersqualifiedname.
pub.soap.handler:listProvider
WmPublic.Returnsalistoftheproviderhandlersthatarecurrentlyregisteredonthe IntegrationServer. Input Parameters None. Output Parameters Handlers String Optional.ValuetowhichyouwantthemustUnderstand attributeset. ThemustUnderstandattributespecifieswhetherrecipientsare requiredtoprocessaheaderentry(thatis,whetherprocessingofthe entryismandatoryoroptional).Recipientsthatcannotprocessa mandatoryheaderentrymustrejectthemessageandreturnaSOAP fault. Key descriptiveName className policyType Headers Description String Optional.Descriptivenamegiventothe SOAPproviderhandlerwhenitwasregistered. String Classnameofthehandler. String Policytypeofthehandler. Document List Listofavailableproviderheaders. Key namespace localName Description String Namespaceportionofthe headersqualifiedname. String Localportionofthe headersqualifiedname.
461
27 SOAP Folder
pub.soap.handler:registerConsumer
WmPublic.RegistersthehandlerfortheconsumerWebservicedescriptor. Input Parameters descriptiveName handler handlerInfo Output Parameters None. String Optional.DescriptivenamefortheSOAPconsumerhandler. ObjectTheinstanceofthehandlerobject. ObjectOptional.TheinstanceofthehandlerInfoobject.
pub.soap.handler:registerProvider
WmPublic.RegistersthehandlerfortheproviderWebservicedescriptor. Input Parameters descriptiveName handler handlerInfo Output Parameters None. String Optional.DescriptivenamefortheSOAPproviderhandler. ObjectTheinstanceofthehandlerobject. ObjectOptional.TheinstanceofthehandlerInfoobject.
pub.soap.handler:unregisterConsumer
WmPublic.UnregistersthehandlerfortheconsumerWebservicedescriptor. Input Parameters descriptiveName Output Parameters None. String Optional.DescriptivenamethatwasgiventotheSOAP consumerhandlerwhenitwasregistered.
462
27 SOAP Folder
pub.soap.handler:unregisterProvider
WmPublic.UnregistersthehandlerfortheproviderWebservicedescriptor. Input Parameters descriptiveName Output Parameters None. String Optional.DescriptivecommentthatwasgiventotheSOAP providerhandlerwhenitwasregistered.
pub.soap.processor:list
WmPublic.ReturnsalistoftheSOAPprocessorsthatarecurrentlyregisteredonthe IntegrationServer. Input Parameters None. Output Parameters list Document ListListofprocessorscurrentlyregisteredontheserver.Each documentinthelistcontainsthefollowinginformation: Key directive svcName descriptiveName Description String ProcessdirectivethatisassignedtotheSOAP processor. String Fullyqualifiednameoftheservicethat functionsastheSOAPprocessor. String Descriptivecommentthatwasgiventothe SOAPprocessorwhenitwasregistered.Thiselement willbeemptyiftheprocessorwasnotregisteredwith adescriptivecomment.
463
27 SOAP Folder
validateSOAPMessage
String FlagindicatingwhethertheSOAPmessage handlervalidatestheSOAPmessagesthatthis processorsendsandreceives. A value of...

true
Indicates that... MessagesarevalidatedbytheSOAP messagehandler.Beawarethatthe validationprocesschecksonlythatthe messageenvelopeisstructuredcorrectly. Forexample,itchecksthemessagehasat leastonebodyelementandthereisat mostoneheaderelement.Itdoesnot validateanyofthedatacarriedbythe message. Thissettingoverridestheserversglobal
watt.server.SOAP.validateSOAPMessage
setting.
false
MessagesarenotvalidatedbytheSOAP messagehandler. Thissettingoverridestheserversglobal

setting. IfvalidateSOAPMessageisnull,messagevalidationfor theprocessorisdeterminedbytheservers watt.server.SOAP.validateSOAPMessagesetting. See Also pub.soap.processor:registerProcessor pub.soap.processor:unregisterProcessor
pub.soap.processor:processMessage
WmPublic.ExecutestheIntegrationServersdefaultSOAPprocessor. ThisservicebehavesexactlylikethebuiltindefaultSOAPprocessor.However,this servicecanbewrappedinaflowservice,whichenablesyoutocreateanaccess controlledSOAPprocessor.Forinformationaboutcreatingandregisteringaccess controlledSOAPprocessors,seetheSOAPDevelopersGuide.
464
27 SOAP Folder
Input Parameters soapRequestData soapResponseData Output Parameters soapResponseData Usage Notes YouinvokeprocessMessagefromawrapperservicethatyoucreateandregisterasa SOAPprocessorontheIntegrationServer.Toimposeaccesscontrolontheprocessor, youassignanaccesscontrollist(ACL)tothewrapperservice.Forinformationabout howtousethisservice,seetheSOAPDevelopersGuide. Object SOAPobjectcontainingtheSOAPresponsemessagethatis tobereturnedtotheclient. Object SOAPobjectcontainingtheSOAPrequestsubmittedtothe IntegrationServerbyaclient. Object EmptySOAPobjectthattheservicewillusetocomposethe SOAPresponsemessage.
pub.soap.processor:processRPCMessage
WmPublic.ExecutestheIntegrationServersSOAPRPCprocessor. ThisservicebehavesexactlylikethebuiltinSOAPRPCprocessor.However,thisservice canbewrappedinaflowservice,whichenablesyoutocreateanaccesscontrolledSOAP processor.ForinformationaboutcreatingandregisteringaccesscontrolledSOAP processors,seetheSOAPDevelopersGuide. Input Parameters soapRequestData soapResponseData Output Parameters soapResponseData Usage Notes YouinvokeprocessRPCMessagefromawrapperservicethatyoucreateandregisterasa SOAPprocessorontheIntegrationServer.Toimposeaccesscontrolontheprocessor, youassignanaccesscontrollist(ACL)tothewrapperservice.Forinformationabout howtousethisservice,seetheSOAPDevelopersGuide. ObjectSOAPobjectcontainingtheSOAPresponsemessagethatis tobereturnedtotheclient. Object SOAPobjectcontainingtheSOAPrequestsubmittedtothe IntegrationServerbyaclient. Object EmptySOAPobjectthattheservicewillusetocomposethe SOAPresponsemessage.
465
27 SOAP Folder
pub.soap.processor:registerProcessor
WmPublic.RegistersaserviceasaSOAPprocessorontheIntegrationServer. Input Parameters directive StringProcessdirectivethatyouwanttoassigntotheSOAP processor. Note: Useonlyletters,digits,orthecharacters_.!~*()inthe nameyouspecifyindirective. svcName descriptiveName String Fullyqualifiednameoftheservicethatyouare registeringasaSOAPprocessor. String DescriptivecommentforthisSOAPprocessor.This commentisshownwhenyouruntheutilityservice pub.soap.processor:listtogetalistoftheregisteredSOAP processors. String Optional.FlagindicatingwhethertheSOAPmessage handlervalidatestheSOAPmessagesthatthisprocessor sendsandreceives. Set to...
true
validateSOAPMessage
To... ValidatemessagessentandreceivedbythisSOAP processor.Beawarethatthevalidationprocess checksonlythatthemessageenvelopeis structuredcorrectly.Forexample,itchecksthe messagehasatleastonebodyelementandthereis atmostoneheaderelement.Itdoesnotvalidate anyofthedatacarriedbythemessage. Thissettingoverridestheserversglobal

setting.
false
Bypassvalidationonmessagessentandreceived bythisSOAPprocessor. Thissettingoverridestheserversglobal

setting.
Or,leavevalidateSOAPMessagenulltovalidatemessages accordingtotheIntegrationServers watt.server.SOAP.validateSOAPMessage setting.Thisisthe default. Output Parameters None.
466
27 SOAP Folder
Usage Notes ForinformationaboutcreatingandregisteringSOAPprocessors,seetheSOAP DevelopersGuide. See Also pub.soap.processor:list pub.soap.processor:unregisterProcessor Examples SeethefollowingintheWmSamplespackageinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.soap:registerProcessor
pub.soap.processor:unregisterProcessor
WmPublic.UnregistersaSOAPprocessorbyremovingitfromtheregistry. Input Parameters directive String Processdirectivethatyouwanttoremovefromtheregistry. Directivenamesarecasesensitive. Tip! ToobtainalistofthecurrentSOAPprocessordirectives registeredontheserver,runthepub.soap.processor:listservice. Output Parameters None. Usage Notes IfthedirectivespecifiedindirectiveisnotregisteredontheIntegrationServer, unregisterProcessorthrowsanexception. See Also pub.soap.processor:list pub.soap.processor:registerProcessor
467
27 SOAP Folder
pub.soap.schema:encoding
WmPublic.SchemathatdefinesthedatatypesSOAPsupports.
pub.soap.schema:envelope
WmPublic.SchemathatdefinesthestructureofaSOAPmessage.
pub.soap.utils:addBodyEntry
WmPublic.InsertsanentryintothebodyelementofaSOAPmessage. Input Parameters soapData bodyEntry Object SOAPobjecttowhichyouwantthebodyentryadded. com.wm.lang.xml.Node XMLnodecontainingthebodyentrythatyou wanttoaddtosoapData. Note: AnXMLnodeisaparsablerepresentationofanodeinanXML document.YougenerateanXMLnodeusingservicessuchas pub.xml:xmlStringToXMLNode. Important! ThisserviceaddsasinglebodyentrytoaSOAPobject.If youneedtoaddmorethanoneentry,execute pub.soap.utils:addBodyEntryonceforeachentry. Important! InwebMethodsIntegrationServerversions6.0.1andlater, thisserviceexpectsthenodeinbodyEntrytobenamespacequalified. Ifthenodeisnotqualified,theservicethrowsanexception.Ifyou createdsolutionsbasedontheearlierbehaviorofthisservice(which permittednonqualifiedentries),youcandisablenamespace enforcementbysettingtheservers watt.server.SOAP.EnforceMsgPartNSparametertofalse.For informationaboutthisparameter,seetheSOAPDevelopersGuide Output Parameters soapData ObjectSOAPobjecttowhichthebodyentrywasadded.
468
27 SOAP Folder
Usage Notes ASOAPobjectisanobjectthatrepresentsaSOAPmessage. IfyouarecomposinganewSOAPmessage,youmustfirstcreateanemptySOAP object(calledsoapData)withthepub.soap.utils:createSoapDataserviceandthenadd bodyentriestowithaddBodyEntry. IfyouarecomposingaSOAPresponse,youusepub.soap.utils:addBodyEntryto populatethesoapResponseDataobjectthattheSOAPmessagehandlergenerates andputsinthepipeline. ForinformationaboutcomposingSOAPmessages,seetheSOAPDevelopersGuide. See Also pub.soap.utils:createSoapData pub.soap.utils:addBodyEntry pub.soap.utils:addHeaderEntry pub.soap.utils:addTrailer pub.soap.utils:getBody pub.soap.utils:getBodyEntries Examples SeethefollowingintheWmSamplespackagesinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.soap:buildMsg_sendHTTP sample.soap:customProc_msgQuwue sample.soap:targetSvc_defaultProc
pub.soap.utils:addHeaderEntry
WmPublic.InsertsanentryintotheheaderelementofaSOAPmessage. Input Parameters soapData ObjectSOAPobjecttowhichyouwanttheheaderentryadded.
469
27 SOAP Folder
headerEntry
com.wm.lang.xml.Node XMLnodecontainingtheentrythatyouwant toaddtosoapData. Note: AnXMLnodeisaparsablerepresentationofanodeinanXML document.YougenerateanXMLnodeusingservicessuchas pub.xml:xmlStringToXMLNode. Important! ThisserviceaddsasingleheaderentrytoaSOAPobject.If youneedtoaddmorethanoneentry,executeaddHeaderEntryoncefor eachentry. Important! InwebMethodsIntegrationServerversions6.0.1andlater, thisserviceexpectsthenodeinheaderEntrytobenamespace qualified.Ifthenodeisnotqualified,theservicethrowsan exception.Ifyoucreatedsolutionsbasedontheearlierbehaviorof thisservice(whichpermittednonqualifiedentries),youcandisable namespaceenforcementbysettingtheservers watt.server.SOAP.EnforceMsgPartNSparametertofalse.For informationaboutthisparameter,seetheSOAPDevelopersGuide.
mustUnderstand
String Optional.ValuetowhichyouwantthemustUnderstand attributeset. ThemustUnderstandattributespecifieswhetherrecipientsare requiredtoprocessaheaderentry(thatis,whetherprocessingofthe entryismandatoryoroptional).Recipientsthatcannotprocessa mandatoryheaderentrymustrejectthemessageandreturnaSOAP fault. A value of...
0 1
Indicates that... Theheaderisoptional. Theheaderismandatory.
ForadditionalinformationaboutthemustUnderstandattribute,see theSimpleObjectAccessProtocol(SOAP)1.1W3CNote08May2000 athttp://www.w3.org/TR/SOAP/. Note: IfyoudonotsetmustUnderstand,themustUnderstandattribute isomittedfromtheheaderentry,whichisequivalenttosetting mustUnderstandto0.
470
27 SOAP Folder
actor
String Optional.Valuetowhichyouwanttheactorattributeset. TheactorattributespecifiesaURIthatidentifiestherecipientto whichaheaderentryistargeted.Foradditionalinformationabout themustUnderstandattribute,seetheSimpleObjectAccessProtocol (SOAP)1.1W3CNote08May2000at http://www.w3.org/TR/SOAP/.
Output Parameters soapData Usage Notes ASOAPobjectisanobjectthatrepresentsaSOAPmessage. IfyouarecomposinganewSOAPmessage,youmustfirstcreateanemptySOAP object(calledsoapData)withthepub.soap.utils:createSoapDataserviceandthenadd yourheaderentriestowithaddHeaderEntry. IfyouarecomposingaSOAPresponse,youuseaddHeaderEntrytopopulatethe soapResponseDataobjectthattheSOAPmessagehandlergeneratesandputsinthe pipeline. ForinformationaboutcomposingSOAPmessages,seetheSOAPDevelopersGuide. See Also pub.soap.utils:createSoapData pub.soap.utils:addBodyEntry pub.soap.utils:addTrailer pub.soap.utils:getHeader pub.soap.utils:getHeaderEntries Examples SeethefollowingintheWmSamplespackagesinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.soap:buildMsg_sendHTTP sample.soap:targetSvc_defaultProc ObjectSOAPobjecttowhichtheheaderentrywasadded.
471
27 SOAP Folder
pub.soap.utils:addTrailer
WmPublic.InsertsatrailerinaSOAPmessage. (AtrailerisanarbitraryelementthatfollowstheBodyelementintheSOAPenvelope.) Important! Itappearslikelythattrailerswillnotbepermittedinfutureversionsof SOAP(versions1.2andlater).Ifyouaredesigningacompletelynewsolution,we recommendthatyouavoidusingtrailers.However,ifyouexchangeSOAPmessages witholdersystemsthatalreadymakeuseoftrailers,thisserviceallowsyoutoinsert themintoaSOAPmessage. Input Parameters soapData trailer Object SOAPobjecttowhichyouwantthetraileradded. com.wm.lang.xml.Node XMLnodecontainingthetrailerthatyouwant toaddtosoapData. Note: AnXMLnodeisaparsablerepresentationofanodeinanXML document.YougenerateanXMLnodeusingservicessuchas pub.xml:xmlStringToXMLNode. Important! ThisserviceaddsasingletrailertoaSOAPobject.Ifyou needtoinsertmorethanonetrailerinthemessage,executeaddTrailer onceforeachtrailerthatneedstobeadded. Note: TheSOAPspecificationstatesthattrailersmustbenamespace qualified,sobesurethatthenodeintrailerspecifiesanamespace. Output Parameters soapData Usage Notes ASOAPobjectisanobjectthatrepresentsaSOAPmessage. IfyouarecomposinganewSOAPmessage,youmustfirstcreateanemptySOAP object(calledsoapData)withthecreateSoapDataserviceandthenaddyourheader entriestowithpub.soap.utils:addHeaderEntry. IfyouarecomposingaSOAPresponse,youusepub.soap.utils:addHeaderEntryto populatethesoapResponseDataobjectthattheSOAPmessagehandlergenerates andputsinthepipeline. ForinformationaboutcomposingSOAPmessages,seetheSOAPDevelopersGuide. ObjectSOAPobjecttowhichthetrailerwasadded.
472
27 SOAP Folder
See Also pub.soap.utils:createSoapData pub.soap.utils:addHeaderEntry pub.soap.utils:addBodyEntry pub.soap.utils:getTrailers
pub.soap.utils:createSoapData
WmPublic.CreatesanemptySOAPobject. TocomposeanewSOAPmessage,youfirstusethisservicetocreateanemptySOAP object,andthenyouaddcontenttotheSOAPobjectusingservicessuchas pub.soap.utils:addHeaderEntryandpub.soap.utils:addBodyEntry. Input Parameters encoding soapProtocol StringOptional.Specifiestheencodingmethod.Defaultvalueis UTF8. StringOptional.IndicatestheSOAPprotocolthattheemptySOAP objectcomplieswith.Thedefaultvalueisreadfromthe watt.server.SOAP.defaultProtocolproperty. Set to...
SOAP 1.1protocol
To... IndicatetheSOAPobjectcomplieswith SOAP 1.1. IndicatetheSOAPobjectcomplieswith SOAP 1.2.
SOAP 1.2 protocol
Output Parameters soapData Usage Notes TheencodingparametercansupportincomingSOAPmessagesinanyencoding. Outgoingmessages,however,arealwaysencodedinUTF8. ForinformationaboutcomposingSOAPmessages,seetheSOAPDevelopersGuide. See Also pub.soap.utils:addHeaderEntry pub.soap.utils:addBodyEntry pub.soap.utils:addTrailer ObjectEmptySOAPobject.
473
27 SOAP Folder
Examples SeethefollowingintheWmSamplespackageinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.soap:buildMsg_sendHTTP
pub.soap.utils:exitUnableToUnderstand
WmPublic.TerminatesprocessingandreturnsamustUnderstandfaulttotheclient. YouexecutethisservicewhenyourSOAPprocessordetectsamandatoryheaderentry thatitcannotprocess. Input Parameters headerEntry com.wm.lang.xml.Node XMLnodecontainingtheheaderentrythatcannot beunderstood.
Output Parameters None. Usage Notes Thisservicethrowsanexception,whichismeanttobecaughtbythemessagehandler sothattheappropriateSOAPfaultwillbereturnedtotheclient.Yourprocessor shouldnotcatchthisexception.
pub.soap.utils:getActor
WmPublic.Retrievesthevalueoftheactorattribute(forSOAP1.1)ortheroleattribute (forSOAP1.2)fromagivenheaderentry. Input Parameters headerEntry com.wm.lang.xml.Node Theheaderentrywhoseactorvalueyouwantto retrieve. Ifyouusepub.soap.utils:getHeaderEntriestoretrieveheaderentries,you canloopoverthelistofheadernodestoretrievetheactor value fromeachentry. Ifyouusepub.soap.utils:getHeadertoretrieveheaderentries,youmust querythenodereturnedbythatservice(usingthe pub.xml:queryXMLNodeservice)toextractanodeforanindividual headerentry.ThenyoucanrungetActorontheresultingnode.
474
27 SOAP Folder
Output Parameters actor StringValueoftheheaderentrysactorattribute(forSOAP1.1)or theroleattribute(forSOAP1.2).Iftheheaderentrydoesnothavean actorattribute,actorwillbenull.
Usage Notes ForgeneralinformationabouttheSOAPheaderentriesandattributes,seetheSOAP DevelopersGuide. See Also pub.soap.utils:addHeaderEntry pub.soap.utils:getMustUnderstand pub.soap.utils:getHeader pub.soap.utils:getHeaderEntries
pub.soap.utils:getBody
WmPublic.RetrievesthebodyfromaSOAPmessageasasinglenodeobject. Input Parameters soapData Output Parameters body Usage Notes ThisservicereturnstheentireBodyelementinbody.ToextractdatafromtheBody element,querybodywiththepub.xml:queryXMLNodeservice. Ifyouwanttoextractthebodyofthemessageasanarrayofnodes,usethe pub.soap.utils:getBodyEntriesservice. ForadditionalinformationaboutextractinginformationfromSOAPmessages,see theSOAPDevelopersGuide. See Also pub.soap.utils:getBodyEntries pub.soap.utils:addBodyEntry com.wm.lang.xml.Node TheBodynodefromtheSOAPmessage(that is,<SOAP-ENV:Body>to</SOAP-ENV:Body>). ObjectSOAPobjectcontainingthemessagewhoseBodynodeyou wanttoretrieve.
475
27 SOAP Folder
Examples SeethefollowingintheWmSamplespackagesinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.soap:buildMsg_sendHTTP sample.soap:customProc_msgQueue sample.soap:targetSvc_defaultProc
pub.soap.utils:getBodyEntries
WmPublic.RetrievesthebodyentriesfromaSOAPmessageasanarrayofnodeobjects. Input Parameters soapData Output Parameters bodyEntries Usage Notes Thisservicereturnseachbodyentryasaseparatenode.YoucanloopoverbodyEntries andextractdatafromeachnodewiththepub.xml:queryXMLNodeservice. Ifyouwanttoextractthebodyofthemessageasasinglenode,usethe pub.soap.utils:getBodyservice. ForadditionalinformationaboutextractinginformationfromSOAPmessages,see theSOAPDevelopersGuide. See Also pub.soap.utils:getBody pub.soap.utils:addBodyEntry com.wm.lang.xml.Node[ ] AnarrayofXMLnodes,whereeachnode representsabodyentryfromthemessage. ObjectTheSOAPobjectcontainingthemessagewhosebodyentries youwanttoretrieve.
pub.soap.utils:getDocument
WmPublic.RetrievesanentireSOAPmessageasanodeobject. Thisserviceisusefulwhenyouwanttousepub.xml:queryXMLNodetoqueryanentireSOAP message.SincequeryXMLNoderequiresanodeasinput,youcannotuseittoqueryaSOAP objectdirectly.Instead,youmustconverttheSOAPobjecttoanodeandthenquerythe resultingnode.
476
27 SOAP Folder
Input Parameters soapData Output Parameters node com.wm.lang.xml.Node NoderepresentationoftheentireSOAP messageinsoapData(thatis,<SOAP-ENV:Envelope>to</SOAPENV:Envelope>.
ObjectSOAPobjectforwhichyouwantanoderepresentation.
Usage Notes ForadditionalinformationaboutextractinginformationfromSOAPmessages,see theSOAPDevelopersGuide. See Also pub.soap.utils:getBody pub.soap.utils:getBodyEntries pub.soap.utils:getHeader pub.soap.utils:getHeaderEntries pub.soap.utils:getTrailers
pub.soap.utils:getHeader
WmPublic.RetrievestheheaderfromaSOAPmessageasasinglenodeobject. Input Parameters soapData Output Parameters header Usage Notes ThisservicereturnstheentireHeaderelementinheader.Toextractdatafromthe Headerelement,queryheaderwiththepub.xml:queryXMLNodeservice.Ifyouwantto extractthecontentsoftheheaderasanarrayofnodes,usethe pub.soap.utils:getHeaderEntriesservice. ForadditionalinformationaboutextractinginformationfromSOAPmessages,see theSOAPDevelopersGuide. com.wm.lang.xml.Node HeadernodefromtheSOAPmessage(thatis, <SOAP-ENV:Header>to</SOAP-ENV:Header>). ObjectSOAPobjectcontainingthemessagewhoseHeadernodeyou wanttoretrieve.
477
27 SOAP Folder
See Also pub.soap.utils:getHeaderEntries pub.soap.utils:getBody pub.soap.utils:getBodyEntries pub.soap.utils:getTrailers pub.soap.utils:addHeaderEntry Examples SeethefollowingintheWmSamplespackageinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.soap:customProc_msgQueue
pub.soap.utils:getHeaderEntries
WmPublic.RetrievestheheaderentriesfromaSOAPmessageasanarrayofnode objects. Thisserviceisusefulwhenyouwanttobuildaprocessthatloopsthroughalltheheader entriesinamessageandidentifyentrieswithspecificQNames(usingthe pub.soap.utils:getQNameservice)oractorattributes(usingthepub.soap.utils:getActorservice). Input Parameters soapData Output Parameters headerEntries Usage Notes Thisservicereturnseachheaderentryasaseparatenode.Youcanloopover headerEntriesandextractdatafromeachnodewiththepub.xml:queryXMLNodeserviceor gettheentrysQNameand/oractorvalueusingthepub.soap.utils:getQNameand pub.soap.utils:getActorservices. Ifyouwanttoextractthemessageheaderasasinglenode,usethe pub.soap.utils:getHeaderservice. ForadditionalinformationaboutextractinginformationfromSOAPmessages,see theSOAPDevelopersGuide. com.wm.lang.xml.Node[ ] HeaderentriesfromtheSOAPmessage. Eachnodeinthearrayrepresentsaheaderentryfromthemessage. ObjectSOAPobjectcontainingthemessagewhoseheaderentries youwanttoretrieve.
478
27 SOAP Folder
See Also pub.soap.utils:getHeader pub.soap.utils:getBody pub.soap.utils:getBodyEntries pub.soap.utils:getDocument pub.soap.utils:addHeaderEntry pub.soap.utils:getActor pub.soap.utils:getQName
pub.soap.utils:getMustUnderstand
WmPublic.ReturnsthemustUnderstandstatusforagivenheaderentry. ThemustUnderstandstatusspecifieswhetherrecipientsarerequiredtoprocessaheader entry(thatis,whetherprocessingoftheentryismandatoryoroptional).Recipientsthat cannotprocessamandatoryheaderentrymustrejectthemessageandreturnaSOAP fault.(Seethepub.soap.utils:exitUnableToUnderstandservice.) Input Parameters headerEntry com.wm.lang.xml.Node TheheaderentrywhosemustUnderstand statusyouwanttoretrieve. Ifyouusepub.soap.utils:getHeaderEntriestoretrieveheaderentries, youcanloopoverthelistofheadernodestocheckthestatusof eachentry. Ifyouusepub.soap.utils:getHeadertoretrieveheaderentries,you willneedtoquerythenodereturnedbythatservice(usingthe pub.xml:queryXMLNodeservice)toextractanodeforanindividual headerentry.Thenyoucanrunpub.soap.utils:getMustUnderstandon theresultingnode. Output Parameters mustUnderstand String HeaderentrysmustUnderstandstatus.Iftheheaderentryhas amustUnderstandattribute,mustUnderstandwillreturnoneofthe followingvalues: A value of...
0 1
Indicates that... Theheaderisoptional. Theheaderismandatory.
IftheheaderentrydoesnothaveamustUnderstandattribute, mustUnderstandwillreturn0.
479
27 SOAP Folder
Usage Notes ForadditionalinformationaboutthemustUnderstandattribute,seetheSimpleObject AccessProtocol(SOAP)1.1W3CNote08May2000athttp://www.w3.org/TR/SOAP/ andforSOAP1.2,seetheSOAP1.2W3CRecommendation27April2007at http://www.w3.org/TR/soap12part1/. See Also pub.soap.utils:addHeaderEntry pub.soap.utils:getActor pub.soap.utils:getHeader pub.soap.utils:getHeaderEntries pub.soap.utils:exitUnableToUnderstand
pub.soap.utils:getQName
WmPublic.Returnsthequalifiednameforagivennode. Input Parameters node Output Parameters Qname Document Thenodesqualifiedname.Qnamewillcontainthe followingkeys: Key namespaceName localName Usage Notes Generally,youusethisserviceinconjunctionwiththepub.soap.utils:getHeaderEntriesor pub.soap.utils:getBodyEntriesservicetoloopoverthemessagesheaderorbodyentries andidentifyentrieswithaparticularqualifiedname. See Also pub.soap.utils:getBodyEntries pub.soap.utils:getHeaderEntries Description String Namespaceportionofthenodesqualified name. String Localportionofthenodesqualifiedname. com.wm.lang.xml.Node TheXMLnodewhosequalifiednameyou wanttodiscover.
480
27 SOAP Folder
pub.soap.utils:getTrailers
WmPublic.RetrievesthetrailersfromaSOAPmessage. (AtrailerisanarbitraryelementthatfollowstheBodyelementintheSOAPenvelope.) Important! Itappearslikelythattrailerswillnotbepermittedinfutureversionsof SOAP(versions1.2andlater).Ifyouaredesigningacompletelynewsolution,we recommendthatyouavoidusingtrailers.However,ifyouexchangeSOAPmessages witholdersystemsthatalreadymakeuseoftrailers,thisserviceallowsyouto retrievethemfromaSOAPmessage. Input Parameters soapData Output Parameters trailers com.wm.lang.xml.Node[ ] Arrayofnodeswhereineachnoderepresents atrailerfromthemessage.Ifthemessagedoesnotcontaintrailers, trailerswillbenull. ObjectSOAPobjectcontainingthemessagewhosetrailersyouwant toretrieve.
See Also pub.soap.utils:addTrailer pub.soap.utils:getHeader pub.soap.utils:getHeaderEntries pub.soap.utils:getBody pub.soap.utils:getBodyEntries pub.soap.utils:getDocument
pub.soap.utils:QName
WmPublic.Documenttypethatdefinesthestructureofaqualifiedname. Parameters namespaceName localName String Thenamespaceportionofaqualifiedname. String Thelocalportionofaqualifiedname.
481
27 SOAP Folder
pub.soap.utils:removeBodyEntry
WmPublic.DeletesabodyentryfromaSOAPmessage. Input Parameters soapData bodyEntry Object SOAPobjectcontainingthebodyentrythatyouwantto delete. com.wm.lang.xml.Node Optional.Theentrythatyouwanttoremove fromsoapData.(Youwouldobtainthenodewiththe pub.soap.utils:getBodyEntriesservice.) Note: YoucanusebodyEntryorindextospecifytheentrythatyou wantremoveBodyEntrytodelete. index String Optional.Indexoftheentrythatyouwanttoremove(where index0representsthefirstbodyentry).indexisignoredifbodyEntry isspecified.
Output Parameters None. Usage Notes WhenyouusethebodyEntryparameter,besurethatitspecifiesthecorrectnode.This servicedeleteswhatevernodeisspecifiedinbodyEntry,evenifthenodeisnotabody entry.Forexample,ifbodyEntrycontainsthewholeBodyelement,removeBodyEntrywill deletethebodyofthemessage. Note: Beawarethatifyouusetheindexparametertodeleteanentry,youwill changetheindexnumbers(positions)ofallentriesfollowingtheoneyoudeleted. Forexample,ifyourmessagecontainsfourbodyentries(0,1,2,3)andyoudelete entry1,thentheentriesoriginallyatpositions2and3willsubsequentlyoccupy positions1and2. See Also pub.soap.utils:removeHeaderEntry pub.soap.utils:removeTrailer pub.soap.utils:addBodyEntry pub.soap.utils:getBody pub.soap.utils:getBodyEntries
482
27 SOAP Folder
pub.soap.utils:removeHeaderEntry
WmPublic.DeletesaheaderentryfromaSOAPmessage. Input Parameters soapData headerEntry Object SOAPobjectcontainingtheheaderentrythatyouwantto delete. com.wm.lang.xml.Node Optional.Theheaderentrythatyouwantto removefromsoapData.(Youwouldobtainthenodewiththe pub.soap.utils:getHeaderEntriesservice.) Note: YoucanuseheaderEntryorindextospecifytheentrythatyou wantremoveHeaderEntrytodelete. index String Optional.Indexoftheentrythatyouwanttoremove(where index0representsthefirstheaderentry).indexisignoredif headerEntryisspecified.
Output Parameters None. Usage Notes WhenyouusetheheaderEntryparameter,besurethatitspecifiesthecorrectnode. ThisservicedeleteswhatevernodeisspecifiedinheaderEntry,evenifthenodeisnota headerentry.Forexample,ifheaderEntrycontainsthewholeHeaderelement, removeHeaderEntrywilldeletetheentireheaderfromthemessage. Note: Beawarethatifyouusetheindexparametertodeleteanentry,youwill changetheindexnumbers(positions)ofallentriesfollowingtheoneyoudeleted. Forexample,ifyourheadercontainsfourentries(0,1,2,3)andyoudeleteentry1, thentheentriesoriginallyatpositions2and3willsubsequentlyoccupypositions 1and2. See Also pub.soap.utils:removeBodyEntry pub.soap.utils:removeTrailer pub.soap.utils:addHeaderEntry pub.soap.utils:getHeader pub.soap.utils:getHeaderEntries
483
27 SOAP Folder
pub.soap.utils:removeTrailer
WmPublic.DeletesatrailerfromaSOAPmessage. Input Parameters soapData trailer Object SOAPobjectcontainingthetrailerthatyouwanttodelete. com.wm.lang.xml.Node Optional.Thetrailerthatyouwanttoremove fromsoapData.(Youwouldobtainthenodewiththe pub.soap.utils:getTrailersservice.) Note: Youcanusetrailerorindextospecifythetrailerthatyouwant removeTrailer todelete. index String Optional.Indexofthetrailerthatyouwanttoremove(where index0representsthefirsttrailer).indexisignorediftraileris specified.
Output Parameters None. Usage Notes Whenyouusethetrailerparameter,besurethatitspecifiesthecorrectnode.This servicedeleteswhatevernodeisspecifiedintrailer,evenifthenodeisnotatrailer. Forexample,iftrailercontainstheBodyelement,removeTrailerwilldeletetheentire bodyofthemessage. Note: Beawarethatifyouusetheindexparametertodeleteatrailer,youwill changetheindexnumbers(positions)ofalltrailersfollowingtheoneyoudeleted. Forexample,ifyourmessagecontainsfourtrailers(0,1,2,3)andyoudelete trailer1,thenthetrailersoriginallyatpositions2and3willsubsequentlyoccupy positions1and2. See Also pub.soap.utils:removeHeaderEntry pub.soap.utils:removeBodyEntry pub.soap.utils:addTrailer pub.soap.utils:getTrailers
484
27 SOAP Folder
pub.soap.utils:requestResponseSpec
WmPublic.Definestheinput/outputsignatureforacustomprocessorandatarget serviceforthedefaultprocessor. Input Parameters soapRequestData soapResponseData Output Parameters soapResponseData Examples SeethefollowingintheWmSamplespackagesinthecertifiedsamplesareaofthe KnowledgeBaseontheAdvantageWebSite: sample.soap:customProc_msgQueue sample.soap:targetSvc_defaultProc Object SOAPobjectcontainingthemessagethatistobereturned totheclient. Object SOAPobjectcontainingtheSOAPrequestsubmittedtothe IntegrationServerbytheclient. Object EmptySOAPobjectthatthecustomprocessorortarget serviceusestocomposetheSOAPresponsemessage.
pub.soap.utils:resetWSDEffectivePolicy
WmPublic.ReturnstheeffectivepolicyforahandlerinaWebservicedescriptortothe policysetinthePolicynamepropertyinwebMethodsDeveloper. Input Parameters wsdName handlerName Output Parameters None. StringThenameoftheWebservicedescriptorforwhichyouwant toresettheeffectivepolicy. StringThenameofthehandlerforwhichyouwanttoresetthe effectivepolicy.
485
27 SOAP Folder
Usage Notes YoucanalsousewebMethodsDevelopertoresettheeffectivepolicy.InDeveloper, opentheWebservicedescriptor,selectthehandlerontheHandlerstab,andmodify thevalueofEffective policypropertyassignedtothehandler. Thepub.soap.utils:resetWSDEffectivePolicyservicethrowsanexceptioniftheprovided inputsareinvalid. See Also pub.soap.utils.setWSDEffectivePolicy
pub.soap.utils.setWSDEffectivePolicy
WmPublic.SetstheeffectivepolicyforahandlerinaWebservicedescriptor. Input Parameters wsdName handlerName effectivePolicyID Output Parameters None. Usage Notes Thepub.soap.utils.setWSDEffectivePolicyserviceoverridesthepolicyoriginallyassignedto thehandlerintheWebservicedescriptor. Thepub.soap.utils.setWSDEffectivePolicyserviceappliestoproviderWebservice descriptorsaswellasconsumerWebservicedescriptors. Thepub.soap.utils.setWSDEffectivePolicyservicethrowsanexceptionsiftheprovided inputisincorrect.Theservicealsoverifiesthattheprovidedeffectivepolicyactually exists. YoucanalsousewebMethodsDevelopertosettheeffectivepolicy.InDeveloper, opentheWebservicedescriptor,selectthehandlerontheHandlerstab,andmodify thevalueofEffective policypropertyassignedtothehandler. Youcanresettheeffectivepolicyusingthepub.soap.utils:resetWSDEffectivePolicyservice. See Also pub.soap.utils:resetWSDEffectivePolicy StringThenameoftheWebservicedescriptorforwhichyouwant tosettheeffectivepolicy. StringThenameofthehandlerforwhichyouwanttosetthe effectivepolicy. StringTheuniqueidentifierforthepolicythatyouwanttouse withthehandlerintheWebservicedescriptor.
486
27 SOAP Folder
pub.soap.utils:soapDataToString
WmPublic.ConvertsaSOAPobjecttoaString. Thisisusefulwhenyouwanttousethemessagewithaprocessthatrequiresthemessage tobeintheformofaString. Input Parameters soapData Output Parameters string See Also pub.soap.utils:streamToSoapData pub.soap.utils:stringToSoapData StringEntireSOAPmessage. ObjectSOAPobjectthatyouwanttoconverttoaString.
pub.soap.utils:streamToSoapData
WmPublic.ConvertsanInputStreamcontainingaSOAPmessagetoaSOAPobject. (ASOAPmessagemustberepresentedasaSOAPobjecttobeusedwiththedata retrievalservicessuchaspub.soap.utils:getHeaderandpub.soap.utils:getBody). Note: ThisserviceisaconvenientwaytoproduceaSOAPobjectduringdevelopment andtesting.Itisnotmeanttobeusedforproductionpurposesbecauseitdoesnot ensurethatavalidSOAPmessageisproduced.Forproductionpurposes,werecommend thatyoucreateSOAPobjectswiththepub.soap.utils:createSoapDataserviceandpopulate themwiththemessagecompositionservices(forexample,pub.soap.utils:addBodyEntry andpub.soap.utils:addHeaderEntry). Input Parameters stream Output Parameters soapData Object SOAPobjectrepresentationoftheSOAPmessageinstream. java.io.InputStreamSOAPmessagethatistobeconvertedtoa SOAPobject.
487
27 SOAP Folder
Usage Notes BeawarethatifstreamdoesnotcontainavalidSOAPmessage,thisservicedoesnot throwanexception.Instead,itproducesasoapDatathatcontainsarepresentationof whateveritreceivedinstream(whichmightnotevenbeanXMLdocument).Thiswill causeproblemslaterwhenyouattempttousethesoapDatawithotherSOAPutilities orpassittothemessagehandler.TodeterminewhethersoapDatarepresentsavalid SOAPmessage,werecommendthatyoualwaysexecutethe pub.soap.utils:validateSoapDataserviceimmediatelyafterusingstreamToSoapData. See Also pub.soap.utils:stringToSoapData pub.soap.utils:validateSoapData
pub.soap.utils:stringToSoapData
WmPublic.ConvertsaStringcontainingaSOAPmessagetoaSOAPobject. (ASOAPmessagemustberepresentedasaSOAPobjecttobeusedwiththedata retrievalservicessuchaspub.soap.utils:getHeaderandpub.soap.utils:getBody). Note: ThisserviceisaconvenientwaytoproduceaSOAPobjectduringdevelopment andtesting.Itisnotmeanttobeusedforproductionpurposesbecauseitdoesnot ensurethatavalidSOAPmessageisproduced.Additionally,producingaSOAPobject fromaStringisaverytimeconsumingprocess.Forproductionpurposes,we recommendthatyoucreateSOAPobjectswiththesuchaspub.soap.utils:getHeaderand pub.soap.utils:getBody). Input Parameters string Output Parameters soapData Usage Notes BeawarethatifstringdoesnotcontainavalidSOAPmessage,thisservicedoesnot throwanexception.Instead,itproducesasoapDatathatcontainsarepresentationof whateveritreceivedinstring(whichmightnotevenbeanXMLdocument).Thiswill causeproblemslaterwhenyouattempttousethesoapDatawithotherSOAPutilities orpassittothemessagehandler.TodeterminewhethersoapDatarepresentsavalid SOAPmessage,werecommendthatyoualwaysexecutethe pub.soap.utils:validateSoapDataserviceimmediatelyafterusingstringToSoapData. ObjectSOAPobjectrepresentationoftheSOAPmessageinstring. StringSOAPmessagethatistobeconvertedtoaSOAPobject.
488
27 SOAP Folder
See Also pub.soap.utils:streamToSoapData pub.soap.utils:validateSoapData
pub.soap.utils:validateSoapData
WmPublic.VerifiesthataSOAPobjectrepresentsavalidSOAPmessage. YoucanusethisservicetovalidateaSOAPobjectthatwasgenerateddirectlyfroman InputStreamorStringwithpub.soap.utils:stringToSoapDataorpub.soap.utils:streamToSoapData.If soapDatadoesnotcontainavalidSOAPmessage,validateSoapDatawillthrowan exception. ThisservicevalidatestheSOAPobjectagainsttheschemainpub.soap.schema:envelope. Input Parameters soapData Output Parameters None. Usage Notes IfyoucreateSOAPobjectsusingthestandardmessagecompositionservices(for example,pub.soap.utils:createSoapData,pub.soap.utils:addBodyEntry, pub.soap.utils:addHeaderEntry)thereisnoneedtousethisservice.Thisserviceisonly necessarywhenyougenerateaSOAPobjectdirectlyfromanInputStreamoraString. See Also pub.soap.utils:stringToSoapData pub.soap.utils:streamToSoapData ObjectSOAPobjectthatyouwanttovalidate.
489
27 SOAP Folder
490
28
Storage Folder
Youusetheelementsinthestoragefoldertocreate,close,anddeletedatastoresinthe IntegrationServershorttermstore.IntegrationServerusestheshorttermstorefor informationthatneedstopersistacrossserverrestarts.Theshorttermstoreexistsasthe IS_DATASTOREtableinanexternaldatabaseidentifiedtoIntegrationServerthroughthe ISInternalfunctionalalias. InRelease7.1,theIntegrationServer6.1RepositoryServerwasreplacedbyasetof databasetablescollectivelycalledISInternal.DuringIntegrationServerinstallation,you canchoosetousetheembeddedISInternaldatabase,oryoucanchoosetouseanexternal RDBMSinwhichyouhavecreatedorwillcreatetheISInternaldatabasecomponent.If youchoosetheexternalRDBMS,dataassociatedwiththepub.storageserviceswillbe storedintheIS_DATASTOREtableintheISInternaldatabasecomponent.ForDB2,the sizeofaBLOBcolumnisdefinedwhenthetableiscreated;youmightfindthatthe VALUEcolumnintheIS_DATASTOREtableisnotwideenoughtoaccommodateyour pub.storagedata.IfyouhavenotyetcreatedtheISInternaldatabasecomponent,open theappropriatetablecreationscriptbelowinatexteditorandmodifythewidthofthe VALUEcolumnintheIS_DATASTOREtable: <webMethods_7.1_directory>\common\db\scripts\db2\isinternal\20\create\ db2_isi_c_ddl.sql <webMethods_7.1_directory>\common\db\scripts\db2as400\isinternal\20\create\ db2as400_isi_c_ddl.sql IfyouhavealreadycreatedtheISInternaldatabasecomponent,useDB2commandsto modifythewidthoftheVALUEcolumnintheIS_DATASTOREtable.
Locking Considerations
Thefollowingsectionsdescribeingeneralhowthepub.storageserviceshandlelocking requests.Seetheindividualservicedescriptionsformoredetailedinformation.
Data Store Locking

Whenaflowserviceretrievesanentryfromadatastore,theentryislockedtoprevent modificationbyotherusers.Theentry,whichneedstobeunlockedbeforetheflow completes,remainslockeduntilreleasedviaaput(pub.storage:put)oranexplicitunlock (pub.storage:unlock). Whenapub.storageservicelocksanentry,italsoimplicitlylocksthedatastoreinwhich theentryresides.Thisbehaviorpreventsanothersessionfromdeletingtheentiredata store,andtheentriesitcontains,whileyoursessionisworkingwiththeentry. Becarefulwhenexplicitlyunlockingdatastores.Considerthefollowingexample:
491
28 Storage Folder
1 2 3
User_Alocksanitem.Thiscreatestwolocks:anexplicitlockontheentry,andan implicitlockonthedatastore. User_Alaterunlocksthedatastorewhilestillholdingthelockontheentry. User_Blocks,thendeletesthedatastore,includingtheentrylockedbyUser_Ainthe firststep.
WhenUser_Aexplicitlyunlockedthedatastoreinstep2,User_Bwasabletodeletethe entrytheUser_Awasworkingwith.
Automatic Promotion to Exclusive Lock

Ifapub.storageservicetriestoacquireanexclusivelockonaobject,butfindsashared lockfromthesamesessionalreadyinplaceontheobject,theservicewilltrytopromote thelocktoanexclusivelock. Ifapub.storageservicethatrequiresanexclusivelockencountersasharedorexclusive lockheldbyanothersession,itwillwaituntiltheobjectbecomesavailable.Iftheobject remainslockedfortheperiodspecifiedbythewaitlengthparameterpassedbythe service,orthevalueconfiguredonthewatt.server.storage.lock.maxWaitproperty property,theservicewillfail.
Wait Time and Duration

YoucancontrolhowlongIntegrationServerwillwaittoobtainalockandhowlongit willholdalockbyusingthefollowingserverproperties: Youcanchangethelockwaitbyusingthewatt.server.storage.lock.maxWaitproperty fromtheSettings>Extended Settings screenontheIntegrationServerAdministrator. Youcanchangethelockdurationbyusingthewatt.server.storage.lock.maxDuration propertyfromtheSettings>Extended Settings screenontheIntegrationServer Administrator.

Thefollowingelementsareavailableinthisfolder: Element pub.storage:add pub.storage:closeStore pub.storage:deleteStore Package and Description WmPublic.Insertsanewentryintoadatastore. WmPublic.ObsoleteClosesadatastoreandunregisters thedatastorewiththeserver. WmPublic.Deletesadatastoreandallitscontents.Any datainthedatastoreisdeleted.Ifthedatastoredoesnot exist,theservicetakesnoaction.
492
28 Storage Folder
Element pub.storage:get
Package and Description WmPublic.Retrievesavaluefromadatastoreandlocks theentryandthedatastoreonbehalfofthesessionthat invokedtheservice. WmPublic.Obtainsalistofallthekeysinadatastore. WmPublic.Listsallpub.storagelocksheldbythe suppliedlockholderortarget.Ifnoinputissupplied,the servicereturnsalistofallpub.storagelocks. WmPublic.Locksanentryand/ordatastoreonbehalfof thesessioninvokingthisservice. WmPublic.Insertsorupdatesanentryinadatastore.If thekeydoesnotexistinthedatastore,theentryis inserted. WmPublic.ObsoleteOpensorcreatesadatastoreand registersthestorewiththeserver. WmPublic.Releasesallpub.storagelocksheldbythe identifiedlockholdersandids.Ifbothholdersandidsare specified,theserviceignorestheholdersandusesids. WmPublic.Removesanentryfromadatastore. WmPublic.Unlocksanentryoradatastore.
pub.storage:keys pub.storage:listLocks
pub.storage:lock pub.storage:put
pub.storage:registerStore pub.storage:releaseLocks
pub.storage:remove pub.storage:unlock
pub.storage:add
WmPublic.Insertsanewentryintoadatastore. Ifthekeyalreadyexistsinthedatastore,thepub.storage:addservicedoesnothing. Input Parameters storeName key value StringNameofthedatastoreinwhichtoinserttheentry. StringKeyunderwhichtheentryistobeinserted. DocumentValue(IDataobject)tobeinserted.
Output Parameters result StringFlagindicatingwhethertheentrywassuccessfullyadded. A value of...

true false
Indicates that... Thenewentrywasinsertedsuccessfully. Theentrywasnotinserted(usuallybecauseanentryfor keyalreadyexists).
493
28 Storage Folder
pub.storage:closeStore
WmPublic.ObsoleteClosesadatastoreandunregistersthedatastorewiththeserver. Ifthedatastoreisnotregisteredwiththeserver,anexceptionwillbethrown.Adata storecannotbeaccessedafterithasbeenunregistered.Ifyouwanttoaccessthedatain thedatastore,youneedtoregisterthedatastoreagainusingpub.storage:registerStore. Input Parameters storeName Output Parameters None. Usage Notes Thisservicedoesnotdeletethecontentsofthedatastore.Ifyouwanttodeletethe contentsofadatastoreinadditiontoclosingandunregisteringthedatastore,usethe pub.storage:deleteStoreservice. StringNameofthedatastoretocloseandunregister.
pub.storage:deleteStore
WmPublic.Deletesadatastoreandallitscontents.Anydatainthedatastoreisdeleted. Ifthedatastoredoesnotexist,theservicetakesnoaction. Input Parameters storeName waitLength StringNameofthedatastoretodelete. StringOptional.Lengthoftime,inmilliseconds,thatyouwanttowait forthisdatastoretobecomeavailablefordeletionifitisalreadylocked byanothersession.ThedefaultisthedefaultMaximumLockWait value,whichisspecifiedonthewatt.server.storage.lock.maxWait property.YoucanupdatethispropertybyusingtheSettings>Extended Settings screenontheIntegrationServerAdministrator.
Output Parameters count StringNumberofdatastoreentriesthatweredeleted.Ifthestoredoes notexist,thisvalueis0.
494
28 Storage Folder
Usage Notes Thisserviceobtainsanexclusivelockonthedatastore,butnolocksontheindividual entriesinthedatastore. Ifthisservicefindsasharedlockfromthesamesessiononthedatastore,theservice willautomaticallypromotethelocktoanexclusivelock. Theexclusivelockpreventsothersessionsfromexecutingservicesthatacquirelocks onthedatastoreorentrieswithinthedatastoreduringthedeleteoperation.
pub.storage:get
WmPublic.Retrievesavaluefromadatastoreandlockstheentryandthedatastoreon behalfofthesessionthatinvokedtheservice. Important! Thisservicedoesnotautomaticallyreleasethelockonthedatastoreor entryafterperformingthegetoperation,soyouneedtomakesurethelockisreleased bycallingthepub.storage:putorpub.storage:unlockservice.Ifyoudonotreleasethelock, othersessionswillnotbeabletoaccesstheresourceuntilIntegrationServer automaticallyreleasesthelockaftertheamountoftimespecifiedonthe watt.server.storage.lock.maxDurationpropertyhaspassed. Input Parameters storeName key waitLength StringNameofthedatastorefromwhichyouwanttoretrievetheentry. StringKeyoftheentrywhosevalueyouwanttoretrieve. StringOptional.Lengthoftime,inmilliseconds,thatyouwanttowait forthisentrytobecomeavailableifitisalreadylockedbyanother session.ThedefaultisthedefaultMaximumLockWaitvalue,whichis specifiedonthewatt.server.storage.lock.maxWaitproperty.Youcan updatethispropertybyusingtheSettings>Extended Settings screenon theIntegrationServerAdministrator. StringOptional.Typeoflockyouwanttoplaceontheentry. Set to...
Exclusive
lockMode
To... Preventsothersessionsfromreadingorupdatingtheentry whileyouareusingit.Theservicealsoobtainsashared lockonthedatastore.Anexclusivelockonanentryallows youtomodifytheentry.
495
28 Storage Folder
Read
Obsolete.Ifthisparameterisspecified,theserviceobtainsa sharedlock. Preventsothersessionsfromobtaininganexclusivelock ontheentry.Theservicealsoobtainsasharedlockonthe datastore.Asharedlockonanentryallowsyoutoread, butnotmodify,theentry.Thisisthedefault.
Share
Output Parameters value DocumentRetrievedentry(IDataobject).Iftherequestedentrydoesnot exist,thevalueofthisparameterisnull.
Usage Notes Ifyourequestanexclusivelockandtheservicefindsasharedlockfromthesame sessionontheentry,theservicewillautomaticallypromotethesharedlockonthe entrytoanexclusivelock. Whenthisservicelocksanentry,italsoacquiresasharedlockontheassociateddata storetopreventanothersessionfromdeletingthedatastore,andtheentriesit contains,whileyoursessionhastheentrylocked.
pub.storage:keys
WmPublic.Obtainsalistofallthekeysinadatastore. Input Parameters storeName Output Parameters keys String ListKeysforthedatastorespecifiedinstoreName. StringNameofthedatastorefromwhichyouwanttoobtainalistof keys.
496
28 Storage Folder
pub.storage:listLocks
WmPublic.Listsallpub.storagelocksheldbythesuppliedlockholderortarget.Ifno inputissupplied,theservicereturnsalistofallpub.storagelocks. Input Parameters holder StringOptional.Identifiestheholderwhosepub.storagelocksaretobe listed.Theformatis_DataStore_<sessionId>,wheresessionIdisa unique,internallygeneratedidentifierfortheclientssessioninIntegration Server. StringOptional.Identifiesthetargetwhosepub.storagelocksaretobe listed.
target
Output Parameters locks Record List Thelistofpub.storagelocks.Thisoutputvariablecanbenull. Value

Id Target
Description StringTheinternalIDofthelock StringItemthatislocked,specifiedasadatastorenameorthe keyforanentry StringHolderofthelock.Thisvalueisgeneratedinternallyby thepub.storageservices. StringEXCLUSIVEorSHARE StringNumberoflockholderssharingthislock StringThetimethelockwascreated.
Holder
Type Count Time
497
28 Storage Folder
pub.storage:lock
WmPublic.Locksanentryand/ordatastoreonbehalfofthesessioninvokingthis service. Important! Whenyoulockanentryordatastoreusingthisservice,youmustrelease thelockbyusingaput(pub.storage:put)oranexplicitunlock(pub.storage:unlock).Ifyou donotreleasethelock,othersessionswillnotbeabletoaccesstheresourceuntil IntegrationServerautomaticallyreleasesthelockaftertheamountoftimespecified onthewatt.server.storage.lock.maxDurationpropertyhaspassed. Important! Becarefulwhenreleasinglockswiththepub.storage:unlockservice.Ifyou releasealockonadatastore,anothersessioncanobtainalockonthedatastoreand deleteit,andtheentriesitcontains,evenifyoursessionstillhaslocksononeormore oftheentries. Input Parameters storeName key StringNameofthedatastorecontainingtheentry. StringOptional.Keyoftheentrythatyouwanttolock. Ifkeyisnotsuppliedandyourequest: Asharedlock,theserviceobtainsasharedlockonthedatastore, allowingothersessionstoreadandmodifyentries,butnottodelete them. Anexclusivelock,theserviceobtainsanexclusivelockonthedata store,preventingothersessionsfromlockingthedatastoreandthe entries,therebypreventingthosesessionsfromreading,modifying, ordeletingtheentriesorthedatastore. IfbothstoreNameandkeyarespecifiedandyourequest: Asharedlock,theserviceobtainsasharedlockonthedatastore andtheentry. Anexclusivelock,theserviceobtainsasharedlockonthedatastore andanexclusivelockontheentry. waitLength StringOptional.Lengthoftime,inmilliseconds,thatyouwanttowait forthisentrytobecomeavailableifitisalreadylockedbyanother session. ThedefaultisthedefaultMaximumLockWaitvalue,whichis specifiedonthewatt.server.storage.lock.maxWaitproperty.Youcan updatethispropertybyusingtheSettings>Extended Settings screenon theIntegrationServerAdministrator.
498
28 Storage Folder
lockMode
StringOptional.Typeoflockyouwanttoplaceontheentryordata store. Set to...

Exclusive
To... Preventsothersessionsfromobtainingalockonthedata storeorentry. Anexclusivelockonanentryallowsyoutomodifythe entry,andpreventsothersessionsfromreadingor modifyingtheentry. Anexclusivelockonadatastorealsolockstheentriesin thedatastore.Inaddition,anexclusivelockonadata storeallowsyoutodeletethedatastore.
Read
Obsolete.Ifthisparameterisspecified,theserviceobtainsa sharedlock. Preventsothersessionsfromobtaininganexclusivelock onanentryoradatastore.Asharedlockonanentry allowsyoutoread,butnotmodify,theentry.Ashared lockonadatastorepreventsanothersessionfrom deletingthedatastore.Thisisthedefault.
Share
Output Parameters None. Usage Notes Ifyouhavenotspecifiedakey,andyourflowservicedoesnotinvokepub.storage:putor pub.storage:unlock,oryourservicethrowsanexceptionbeforeinvokingpub.storage:putor pub.storage:unlock,theentiredatastoreremainslockeduntiltheamountoftime specifiedonthewatt.server.storage.lock.maxDurationpropertyhaspassed. Ifyourequestanexclusivelockonanentry,theserviceobtainsanexclusivelockon theentryandasharedlockonthedatastore.Ifthisservicefindsasharedlockfrom thesamesessionontheentry,theservicewillautomaticallypromotethesharedlock ontheentrytoanexclusivelock. Ifyourequestasharedlockonanentry,theserviceobtainsasharedlockontheentry andasharedlockonthedatastore. Ifyourequestasharedlockonanentryoradatastoreandthisservicefindsan exclusivelockfromthesamesession,theexistingexclusivelockwillbereused.The exclusivelockwillnotbedemotedtoasharedlock. Ifyourequestanexclusivelockonadatastore,andthisservicefindsasharedlock fromthesamesessiononthedatastore,theservicewillautomaticallypromotethe sharedlockonthedatastoretoanexclusivelock.
499
28 Storage Folder
pub.storage:put
WmPublic.Insertsorupdatesanentryinadatastore.Ifthekeydoesnotexistinthedata store,theentryisinserted. Iftherequestedentryisnotcurrentlylockedbythesessionthatinvokedthisservice,the pub.storage:putservicewillautomaticallyattempttolocktheentryforthedurationofthe putoperation. Theserviceobtainsanexclusivelockontheentryandasharedlockonthedatastore.If theservicefindsasharedlockfromthesamesessionontheentry,theservicewill automaticallypromotethesharedlocktoanexclusivelock. Thisservicereleasesthelockwhentheputoperationhascompleted. Input Parameters storeName value waitLength StringNameofthedatastoreintowhichyouwanttoinsertorupdate theentry. DocumentValue(IDataobject)tobeinsertedorupdated. StringOptional.Lengthoftime,inmilliseconds,thatyouwanttowait forthisentrytobecomeavailableifitisalreadylockedbyanother session.Ifthewaitlengthexpiresbeforealockisobtained,theservice failsandthrowsanexception.ThedefaultisthedefaultMaximumLock Waitvalue,whichisspecifiedonthewatt.server.storage.lock.maxWait property.YoucanupdatethispropertybyusingtheSettings>Extended Settings screenontheIntegrationServerAdministrator. Thisparameterisusedonlywhenyourservicedidnotexplicitlylock theentrybeforehand. key StringKeywhereyouwanttoinsertorupdatetheentry.
pub.storage:registerStore
WmPublic.ObsoleteOpensorcreatesadatastoreandregistersthestorewiththeserver. Adatastoremustberegisteredbeforeitcanbeaccessed.Ifthestoreisalreadyregistered withtheserver,thisservicedoesnothing. Input Parameters storeName StringNameofthedatastoretoregister.
500
28 Storage Folder
Output Parameters None. Usage Notes Tounregisterandcloseastore,usetheservicepub.storage:closeStore.
pub.storage:releaseLocks
WmPublic.Releasesallpub.storagelocksheldbytheidentifiedlockholdersandids.If bothholdersandidsarespecified,theserviceignorestheholdersandusesids. Thisserviceisintendedprimarilyforadministrators.Itismostusefulwhenusedin combinationwithpub.storage:listLocks.Youcanmapthelocks/holderstringlistfrom thatservicetotheholdersinputvariableinthisserviceorthelocks/idstringlisttotheids inputvariables.Ifneitheridsnorholdersaresupplied,nolocksarereleased. Important! Usethisservicewithcare.Itwillreleaselocksheldbyactivesessionsand couldcausetheirprocessingtofail.Inaddition,ifyoureleasealockonadatastore, anothersessioncanobtainalockonthedatastoreanddeleteit,andtheentriesit contains,eveniftheoriginalsessionstillhaslocksononeormoreoftheentries. Input Parameters holders ids Output Parameters count String ListNumberoflocksthatwerereleased. String List Optional.Holderswhosepub.storagelocksaretobe released. String Optional.Idswhosepub.storagelocksaretobereleased.
501
28 Storage Folder
pub.storage:remove
WmPublic.Removesanentryfromadatastore. Thisserviceobtainsanexclusivelockontheentryandasharedlockonthedatastore. Input Parameters storeName key waitLength StringNameofthedatastorefromwhichtoremoveanentry. StringKeyoftheentrythatyouwanttoremove. StringOptional.Lengthoftime,inmilliseconds,thatyouwantto waitforthisentrytobecomeavailablefordeletionifitisalready lockedbyanothersession.ThedefaultisthedefaultMaximumLock Waitvalue,whichisspecifiedonthe watt.server.storage.lock.maxWaitproperty.Youcanupdatethis propertybyusingtheSettings>Extended Settings screenonthe IntegrationServerAdministrator.
Output Parameters result StringFlagindicatingwhethertheentrywassuccessfullyremoved. A value of...

true false
Indicates that... Theentrywasremovedsuccessfully. Theentrywasnotremoved(usuallybecauseanentry forkeydoesnotexist).
pub.storage:unlock
WmPublic.Unlocksanentryoradatastore. Whenaflowserviceretrievesanentryusingthepub.storage:getservice,theentryislocked topreventmodificationbyotherusersbeforetheflowcompletes.Theentryremains lockeduntilthelockownerinvokesapub.storage:putservice.Tounlockaservicewithout usingthepub.storage:putservice,usethepub.storage:unlockservice. Inaddition,ifaflowserviceusesthepub.storage:lockservicetolockanentryordatastore, youmustusethepub.storage:unlockorpub.storage:put servicetoreleasethelock. Important! Becarefulwhenreleasinglockswiththisservice.Ifyoureleasealockona datastore,anothersessioncanobtainalockonthedatastoreanddeleteit,andthe entriesitcontains,eveniftheoriginalsessionstillhaslocksononeormoreofthe entries.
502
28 Storage Folder
Input Parameters storeName key StringNameofthedatastoreinwhichtounlockanentry. StringOptional.Keyoftheentrythatyouwanttounlock.Ifkeyis notsupplied,thelockwillberemovedfromthedatastorespecified instoreName,butanylocksonentriesinthedatastorewillremain.
503
28 Storage Folder
504
29
String Folder
Youusetheelementsinthestringfoldertoperformstringmanipulationandsubstitution operations.
505
29 String Folder

Thefollowingelementsareavailableinthisfolder: Element pub.string:base64Decode pub.string:base64Encode pub.string:bytesToString pub.string:concat pub.string:HTMLDecode pub.string:HTMLEncode pub.string:indexOf pub.string:length pub.string:lookupDictionary pub.string:lookupTable pub.string:makeString pub.string:messageFormat pub.string:numericFormat pub.string:padLeft pub.string:padRight pub.string:replace pub.string:stringToBytes pub.string:substring pub.string:toLower Package and Description WmPublic.DecodesaBase64encodedstringintoa sequenceofbytes. WmPublic.ConvertsasequenceofbytesintoaBase64 encodedString. WmPublic.ConvertsasequenceofbytestoaString. WmPublic.Concatenatestwostrings. WmPublic.ReplacesHTMLcharacterentitieswithnative characters. WmPublic.ReplacesHTMLsensitivecharacterswith equivalentHTMLcharacterentities. WmPublic.Returnstheindexofthefirstoccurrenceofa sequenceofcharactersinastring. WmPublic.Returnsthelengthofastring. WmPublic.Looksupagivenkeyinahashtableandreturns thestringtowhichthatkeyismapped. WmPublic.LocatesakeyinaStringTableandreturnsthe stringtowhichthatkeyismapped. WmPublic.Buildsasinglestringbyconcatenatingthe elementsofaStringList. WmPublic.Formatsanarrayofstringsintoagivenmessage pattern. WmPublic.Formatsanumberintoagivennumericpattern. WmPublic.Padsastringtoaspecifiedlengthbyaddingpad characterstothebeginningofthestring. WmPublic.Padsastringtoaspecifiedlengthbyaddingpad characterstotheendofthestring. WmPublic.Replacesalloccurrencesofaspecifiedsubstring withasubstitutestring. WmPublic.Convertsastringtoabytearray. WmPublic.Returnsasubstringofagivenstring. WmPublic.Convertsallcharactersinagivenstringto lowercase.
506
29 String Folder
Element pub.string:toUpper pub.string:tokenize
Package and Description WmPublic.Convertsallcharactersinagivenstringto uppercase. WmPublic.Tokenizesastringusingspecifieddelimiter charactersandgeneratesaStringListfromtheresulting tokens. WmPublic.Trimsleadingandtrailingwhitespacefroma givenstring. WmPublic.DecodesaURLencodedstring. WmPublic.URLencodesastring.
pub.string:trim pub.string:URLDecode pub.string:URLEncode
pub.string:base64Decode
WmPublic.DecodesaBase64encodedstringintoasequenceofbytes. Input Parameters string String ABase64encodedStringtodecodeintobytes.
Output Parameters value byte[ ] ThesequenceofbytesdecodedfromtheBase64encodedString.
pub.string:base64Encode
WmPublic.ConvertsasequenceofbytesintoaBase64encodedString. Input Parameters bytes byte[ ] SequenceofbytestoencodeintoaBase64encodedString.
Output Parameters value String Base64encodedStringencodedfromthesequenceofbytes.
507
29 String Folder
pub.string:bytesToString
WmPublic.ConvertsasequenceofbytestoaString. Input Parameters bytes encoding byte[ ] SequenceofbytestoconverttoaString. String Optional.Nameofaregistered,IANAcharacterset(forexample,
ISO-8859-1).Ifyouspecifyanunsupportedencoding,thesystem
throwsanexception. Tousethedefaultencoding,setencodingtoautoDetect. Output Parameters string StringStringrepresentationofthecontentsofbytes.
pub.string:concat
WmPublic.Concatenatestwostrings. Input Parameters inString1 inString2 StringStringtowhichyouwanttoconcatenateanotherstring. StringStringtoconcatenatetoinString1.
Output Parameters value StringResultofconcatenatinginString1withinString2(inString1+ inString2).
pub.string:HTMLDecode
WmPublic.ReplacesHTMLcharacterentitieswithnativecharacters. Specifically,theservice: Replaces this HTML character entity...
> < & "
With...
> < & "
508
29 String Folder
Input Parameters inString StringAnHTMLencodedString.
Output Parameters value StringResultfromdecodingthecontentsofinString.AnyHTML characterentitiesthatexistedininStringwillappearasnativecharacters invalue.
pub.string:HTMLEncode
WmPublic.ReplacesHTMLsensitivecharacterswithequivalentHTMLcharacter entities. Specifically,thisservice: Replaces this native language character...
> < & "
With...
> < & "
ThesetranslationsareusefulwhendisplayingtextinanHTMLcontext. Input Parameters inString StringThecharacteryouwanttoencodeinHTML.
Output Parameters value StringResultfromencodingthecontentsofinString.AnyHTML sensitivecharactersthatexistedininString(forexample,>or&)will appearastheequivalentHTMLcharacterentitiesinvalue.
509
29 String Folder
pub.string:indexOf
WmPublic.Returnstheindexofthefirstoccurrenceofasequenceofcharactersina string. Input Parameters inString subString fromIndex StringStringinwhichyouwanttolocateasequenceofcharacters. StringSequenceofcharacterstolocate. StringOptional.IndexofinStringfromwhichtostartthesearch.Ifno valueisspecified,thisparametercontains0toindicatethebeginningof thestring.
Output Parameters value StringIndexofthefirstoccurrenceofsubStringininString.Ifno occurrenceisfound,thisparametercontains-1.
pub.string:length
WmPublic.Returnsthelengthofastring. Input Parameters inString StringStringwhoselengthyouwanttodiscover.
Output Parameters value StringThenumberofcharactersininString.
pub.string:lookupDictionary
WmPublic.Looksupagivenkeyinahashtableandreturnsthestringtowhichthatkey ismapped. Input Parameters hashtable key java.util.HashtableHashtablethatusesStringobjectsforkeysandvalues. StringKeyinhashtablewhosevalueyouwanttoretrieve. Note: Thekeyiscasesensitive.
510
29 String Folder
Output Parameters value StringValueofthestringtowhichkeyismapped.Iftherequestedkeyin hashtableisnullorifkeyisnotmappedtoanyvalueinhashtable,the servicereturnsnull.
pub.string:lookupTable
WmPublic.LocatesakeyinaStringTableandreturnsthestringtowhichthatkeyis mapped. Input Parameters lookupTable keyColumnIndex valueColumnIndex key String [ ] [ ]Amultirow,multicolumnstringtableinwhichto search. String Indexofthekeycolumn.Defaultis0. String Indexofthevaluecolumn.Defaultis1. String Keytolocate. Note: Thekeyiscasesensitive. ignoreCase String Optional.Flagindicatingwhethertoperformacase sensitiveorcaseinsensitivesearch. Set to...
true false
To... Performacaseinsensitivesearch. Default.Performacasesensitivesearch.
useRegex
String Optional.Flagindicatingwhetherthevaluesinthetableare tobeinterpretedasregularexpressions. Note: Theregularexpressionsinthetableshouldnotinclude slashes.Forexample,usehello.*,not/hello.*/. Set to...

true
To... Interpretthekeycolumnvaluesinthetableas regularexpressions. Default.Interpretthekeycolumnvaluesinthetable asliteralvalues(thatis,notregularexpressions).
false
Output Parameters value StringFirstvalueinthevaluecolumnwhosekeymatcheskey.Ifno matchisfound,thisparameterisnull.
511
29 String Folder
pub.string:makeString
WmPublic.BuildsasinglestringbyconcatenatingtheelementsofaStringList. Input Parameters elementList separator Output Parameters value StringResultfromconcatenatingthestringsinelementList.Strings areseparatedbythecharactersspecifiedinseparator. String List Stringstoconcatenate. StringStringtoinsertbetweeneachnonnullelementinelementList.
pub.string:messageFormat
WmPublic.Formatsanarrayofstringsintoagivenmessagepattern. Input Parameters pattern StringMessagethatincludesplaceholderswhereelementsfrom argumentListaretobeinserted.Themessagecancontainany sequenceofcharacters.Usethe{n}placeholdertoinsertelements fromargumentList,wherenistheindexoftheelementthatyouwant toinsert.Forexample,thefollowingpatternstringinsertselements0 and1intothemessage:
Test results: {0} items passed, {1} items failed.
Note: Donotuseanycharactersexceptdigitsforn. argumentList String ListOptional.Listofstringstousetopopulatepattern.If argumentListisnotsupplied,theservicewillnotreplace placeholdersinpatternwithactualvalues.
Output Parameters value StringResultfromsubstitutingargumentListintopattern.Ifpatternis emptyornull,thisparameterisnull.
512
29 String Folder
pub.string:numericFormat
WmPublic.Formatsanumberintoagivennumericpattern. Input Parameters num pattern StringThenumbertoformat. StringApatternstringthatdescribesthewayinwhichnumistobe formatted: This symbol...
0 # . , ; %
Indicates... Adigit. Adigit.Leadingzeroeswillnotbeshown. Aplaceholderforadecimalseparator. Aplaceholderforagroupingseparator. Aseparationinformat. Thedefaultnegativeprefix. Thatnumwillbemultipliedby100andshownasa percentage. Anycharacterusedasaprefixorsuffix(forexample, A,$). Thatspecialcharactersaretobeusedasliteralsina prefixorsuffix.Enclosethespecialcharacterswithin ''(forexample,'#'). Description Usecommastoseparateintogroupsofthreedigits. Usecommastoseparateintogroupsoffourdigits. Showdigitsbeforethedecimalpointasneededand exactlytwodigitsafterthedecimalpoint.Prefixwith the$character. Showdigitsbeforethedecimalpointasneededand exactlyonedigitafterthedecimalpoint.Prefixwith the#character.
'
Thefollowingareexamplesofpatternstrings: Pattern
#,### #,#### $#.00
'#'#.0
513
29 String Folder
Output Parameters value Stringnumformattedaccordingtopattern.Ifpatternisanempty(not null)string,thedefaultpatternofcommaseparatorsisusedandthe numberofdigitsafterthedecimalpointremainsunchanged.
pub.string:padLeft
WmPublic.Padsastringtoaspecifiedlengthbyaddingpadcharacterstothebeginning ofthestring. Input Parameters inString padString length Output Parameters value StringContentsofinStringprecededbyasmanypadcharactersas neededsothatthetotallengthofthestringequalslength. StringStringthatyouwanttopad. StringCharacterstousetopadinString. StringTotallengthoftheresultingstring,includingpadcharacters.
Usage Notes IfpadStringislongerthanonecharacteranddoesnotfitexactlyintotheresulting string,thebeginningofpadStringisalignedwiththebeginningoftheresultingstring. Forexample,supposeinStringequalsshippedandpadStringequalsx9y. If length equals...

7 10 12
Then value will contain...

shipped x9yshipped x9x9yshipped
IfinStringislongerthanlengthcharacters,onlythelastlengthcharactersfrominString arereturned.Forexample,ifinStringequalsacct1234andlengthequals4,valuewill contain1234.
514
29 String Folder
pub.string:padRight
WmPublic.Padsastringtoaspecifiedlengthbyaddingpadcharacterstotheendofthe string. Input Parameters inString padString length Output Parameters value StringContentsofinStringfollowedbyasmanypadcharactersas neededsothatthetotallengthofthestringequalslength. StringStringthatyouwanttopad. StringCharacterstousetopadinString. StringTotallengthoftheresultingstring,includingpadcharacters.
Usage Notes IfpadStringislongerthanonecharacteranddoesnotfitexactlyintotheresulting string,theendofpadStringisalignedwiththeendoftheresultingstring.For example,supposeinStringequalsshippedandpadStringequalsx9y. If length equals...

7 10 12
Then value will contain...

shipped shippedx9y shippedx9y9y
IfinStringislongerthanlengthcharacters,onlythefirstlengthcharactersfrominString arereturned.Forexample,ifinStringequals1234acctandlengthequals4,valuewill contain1234.
pub.string:replace
WmPublic.Replacesalloccurrencesofaspecifiedsubstringwithasubstitutestring. Input Parameters inString searchString replaceString StringStringcontainingthesubstringtoreplace. StringSubstringtoreplacewithininString. StringCharactersequencethatwillreplacesearchString.Ifthis parameterisnullorempty,theserviceremovesalloccurrencesof searchStringfrominString.
515
29 String Folder
useRegex
StringOptional.FlagindicatingwhethersearchStringisaregular expression.Whenregularexpressionsareusedtospecifyasearch string,replaceStringmayalsocontaininterpolationvariables(for example,$1)thatmatchparentheticalsubexpressionsin searchString. Set to...

true false
To... IndicatethatsearchStringisaregularexpression. Default.IndicatethatsearchStringisnotaregular expression.
Output Parameters value StringContentsofinStringwithreplacementsmade.
pub.string:stringToBytes
WmPublic.Convertsastringtoabytearray. Input Parameters string encoding StringStringtoconverttoabyte[]. String Optional.Nameofaregistered,IANAcharactersetthat specifiestheencodingtousewhenconvertingtheStringtoanarray ofbytes(forexample:ISO-8859-1). Tousethedefaultencoding,setthisvaluetoautoDetect.Ifyou specifyanunsupportedencoding,anexceptionwillbethrown. Output Parameters bytes byte[ ] Contentsofstringrepresentedasabyte[].
pub.string:substring
WmPublic.Returnsasubstringofagivenstring. Input Parameters inString beginIndex endIndex StringStringfromwhichtoextractasubstring. StringBeginningindexofthesubstringtoextract(inclusive). StringEndingindexofthesubstringtoextract(exclusive).Ifthis parameterisnullorempty,thesubstringwillextendtotheendof inString.
516
29 String Folder
Output Parameters value StringSubstringfrombeginIndexandextendingtothecharacterat endIndex1.
pub.string:toLower
WmPublic.Convertsallcharactersinagivenstringtolowercase. Input Parameters inString language country variant Output Parameters value StringContentsofinString,withalluppercasecharactersconverted tolowercase. StringStringtoconvert. StringOptional.Lowercase,twoletterISO639code.Ifthis parameterisnull,thesystemdefaultisused. StringOptional.Uppercase,twoletterISO3166code.Ifthis parameterisnull,thesystemdefaultisused. StringOptional.Vendorandbrowserspecificcode.Ifnull,this parameterisignored.
pub.string:toUpper
WmPublic.Convertsallcharactersinagivenstringtouppercase. Input Parameters inString language country variant Output Parameters value StringContentsofinString,withalllowercasecharactersconverted touppercase. StringStringtoconvert. StringOptional.Lowercase,twoletterISO639code.Ifthis parameterisnull,thesystemdefaultisused. StringOptional.Uppercase,twoletterISO3166code.Ifthis parameterisnull,thesystemdefaultisused. StringOptional.Vendorandbrowserspecificcode.Ifnull,this parameterisignored.
517
29 String Folder
pub.string:tokenize
WmPublic.TokenizesastringusingspecifieddelimitercharactersandgeneratesaString Listfromtheresultingtokens. Thisservicedoesnotreturndelimitersastokens. Input Parameters inString delim StringStringyouwanttotokenize(thatis,breakintodelimited chunks). StringDelimitercharacters.Ifnullorempty,theserviceusesthe defaultdelimiters\t\n\r,wheret,n,andrrepresentthewhitespace characterstab,newline,andcarriagereturn).
Output Parameters valueList String List StringscontainingthetokensextractedfrominString.
pub.string:trim
WmPublic.Trimsleadingandtrailingwhitespacefromagivenstring. Input Parameters inString Output Parameters value StringContentsofinStringwithwhitespacetrimmedfromboth ends. StringStringtotrim.
pub.string:URLDecode
WmPublic.DecodesaURLencodedstring. Input Parameters inString Output Parameters value StringResultfromdecodinginString.IfinStringcontainedplus(+) signs,theywillappearinvalueasspaces.IfinStringcontained%hex encodedcharacters,theywillappearinvalueastheappropriate nativecharacter. StringURLencodedstringtodecode.
518
29 String Folder
pub.string:URLEncode
WmPublic.URLencodesastring. EncodescharactersthesamewaythatdatapostedfromaWWWformisencoded(thatis, theapplication/x-www-form-urlencodedMIMEtype). Input Parameters inString Output Parameters value StringResultfromURLencodinginString.IfinStringcontainednon alphanumericcharacters(except[-_.*@]),theywillappearinvalue astheirURLencodedequivalents(%followedbyatwodigithex code).IfinStringcontainedspaces,theywillappearinvalueasplus (+)signs. StringStringtoURLencode.
519
29 String Folder
520
30
Sync Folder
Youusetheelementsinthesyncfoldertocoordinatetheexecutionofservices.Youcan coordinateservicessothatawaitingservicewillexecuteifandonlyifanotifyingservice producestheinputrequiredbythewaitingservicewithinaspecifiedtimeperiod.The synchronizationserviceswaitforandsendnotificationusingakey.Anotifyingservice onlydeliversinputtowaitingserviceswiththesamekey.
521
30 Sync Folder

Thefollowingelementsareavailableinthisfolder: Element pub.sync:notify pub.sync:wait Package and Description WmPublic.Notifiesserviceswaitingonthespecifiedkeyand deliverstheinputdocumenttotheservices. WmPublic.Allowsoneormoreservicestowaitfordeliveryofdata fromanotifyingservice.
pub.sync:notify
WmPublic.Notifiesserviceswaitingonthespecifiedkeyanddeliverstheinput documenttotheservices. Receivesacountofthenumberofnotifiedservices. Input Parameters key value StringNameofthekey.Waitingserviceswiththesamekeywillreceive notificationandinputfromthisservice. DocumentInputforthewaitingservices.
Output Parameters notified StringNumberindicatinghowmanyserviceswerenotified.
pub.sync:wait
WmPublic.Allowsoneormoreservicestowaitfordeliveryofdatafromanotifying service. Notificationmustoccurwithinaspecifiedtimeperiod. Input Parameters key StringNameofthekeyforwhichtheserviceiswaitingnotification.The servicereceivesnotificationanddatafromanotifyingservicewiththe samekey. StringLengthoftime,inseconds,theservicewaitsfornotification.Ifthe requesttimesout,anexceptionisthrown.
time
522
30 Sync Folder
exclusive
StringOptional.Flagindicatingwhetherotherservicescanwaitfor notificationfromanotifyingservicewiththespecifiedkey. Set to...

yes no
To... Allowonlyoneservicetowaitfornotification. Default.Allowotherservicestowaitfornotification.
Output Parameters value DocumentInputdeliveredbythenotifyingservice.
523
30 Sync Folder
524
31
Synchronization Folder
Youusetheelementsinthesynchronizationfoldertoperformlatchingandcross referencingoperationsinapublishandsubscribeintegration.
525
31 Synchronization Folder

Thefollowingelementsareavailableinthisfolder: Element pub.synchronization.latch:closeLatch pub.synchronization.latch:isLatchClosed pub.synchronization.latch:openLatch pub.synchronization.xref:createXReference pub.synchronization.xref:deleteByObjectId Package and Description WmPublic.Closesthelatchforaresource. WmPublic.Checksaresourceslatchstatus. WmPublic.Opensthelatchforaresource. WmPublic.Createsacrossreferencebetweena canonicalkeyandanativeID. WmPublic.Removesallcrossreference recordsassociatedwithaparticularprocessor synchronization. WmPublic.Deletesacrossreferencerecord fromthecrossreferencetable. WmPublic.Retrievesthecanonicalkeyfora specifiednativeID. WmPublic.RetrievesthenativeIDofa resourcerecordassociatedwithacanonical key. WmPublic.Insertsacrossreferencebetweena nativeIDandacanonicalkey.
pub.synchronization.xref:deleteXReference pub.synchronization.xref:getCanonicalKey pub.synchronization.xref:getNativeId
pub.synchronization.xref:insertXReference
pub.synchronization.latch:closeLatch
WmPublic.Closesthelatchforaresource. Theresourcecannotbeacteduponwhilethelatchisclosed.Byclosingalatch,youcan preventacircularupdatebetweenthesourceandtargetresources. Input Parameters appId StringAuniqueidentifierforthetargetresourceforwhichyouwantto closealatch.Typically,theappIdisthenameoftheadapterorthe resource. StringThecanonicalkey.Auniqueidentifierforthecanonical documentusedinthesynchronization. StringAuniqueidentifierfortheobjectorprocessbeingsynchronized. Typically,theobjectIdfieldissettothenameofthebusinessprocessfor whichyouareperformingsynchronization,suchasorderor customer.
canonicalKey objectId
526
pub.synchronization.latch:isLatchClosed
WmPublic.Checksaresourceslatchstatus. Bycheckingthelatchstatus,youcandeterminewhetheraresourcehasbeenupdated. Input Parameters appId StringAuniqueidentifierfortheresourceforwhichyouwanttocheck thelatchstatus.Typically,theappIdisthenameoftheadapterorthe resource. StringThecanonicalkey.Auniqueidentifierforthecanonical documentusedinthesynchronization. StringAuniqueidentifierfortheobjectorprocessbeingsynchronized. Typically,theobjectIdfieldissettothenameofthebusinessprocessfor whichyouareperformingsynchronization,suchasorderor customer.
canonicalKey objectId
Output Parameters isLatchClosed StringThestatusofthelatch. A value of...

true false
Indicates that... Thelatchisclosed.Theresourcehasbeenupdated. Thelatchisopen.Theresourcehasnotbeen updated.
Usage Notes Usethelatchstatustodeterminewhetherornottoupdatetheresource. Ifthelatchisclosed(isLatchClosedistrue),theresourceisalreadyupdated.Use thepub.synchronization.latch:openLatchservicetoendexecutionoftheupdateand openthelatchinpreparationforthenextupdatetotheresource. Ifthelatchisopen(isLatchClosedisfalse),theresourcehasnotyetbeenupdated. Invokeservicestolocateandupdatetherecordinthetargetresource.Then invokethepub.synchronization.latch:closeLatchservicetoclosethelatchandprevent circularupdates. Formoreinformationaboutusingthepub.synchronization.latchservicestopreventecho suppression,seethePublishSubscribeDevelopersGuide.
527
See Also pub.synchronization.latch:closeLatch pub.synchronization.latch:openLatch
pub.synchronization.latch:openLatch
WmPublic.Opensthelatchforaresource. Byopeningthelatch,youcanendpropagationoftheupdateandmaketheresource availableforfutureupdates. Input Parameters appId canonicalKey objectId StringAuniqueidentifierfortheresourcesforwhichyouwanttoopen thelatch.Typically,theappIdisthenameoftheadapterortheresource. StringThecanonicalkey.Auniqueidentifierforthecanonical documentusedinthesynchronization. StringAuniqueidentifierfortheobjectorprocessbeingsynchronized. Typically,theobjectIdfieldissettothenameofthebusinessprocessfor whichyouareperformingsynchronization,suchasorderor customer.
pub.synchronization.xref:createXReference
WmPublic.CreatesacrossreferencebetweenacanonicalkeyandanativeID. Input Parameters appId nativeId canonicalKey StringAuniqueidentifierfortheresource(application)forwhichyou wanttocreateacrossreferencetoacanonicalkey. StringAuniqueidentifierfortheresourcerecordforwhichyouwant tocreateacrossreferencetoacanonicalkey. StringOptional.Acanonicalkey.Ifacanonicalkeyisnotprovidedas input,createXReferencecreatesthecanonicalkeyandthecross reference. StringAuniqueidentifierfortheobjectorprocessbeing synchronized.Typically,theobjectIdfieldissettothenameofthe businessprocessforwhichyouareperformingsynchronization,such asorderorcustomer.
objectId
528
Output Parameters canonicalKey StringThecanonicalkey.ThiskeycorrelatesnativeIDsofrecords fromdifferentresources.Thiswillbeanew,uniquekeyifcanonicalKey wasnotprovidedasaninputparameter.IfcanonicalKeywasprovided asinput,thisoutputparameterreturnsthesamevalue.
Usage Notes Thecanonicaldocumentisthestandardformatthatadocumentassumeswhileit travelsthroughwebMethodscomponents.Asourceresourcewillconvertormap datafromitsproprietarydataformatintothecanonicalformatbeforepublishingthe document.Atargetresource(asubscribertothecanonicaldocument)willmapthe canonicaldocumenttothetargetresourcesproprietarydataformatbeforeprocessing thedocument.Thecanonicaldocumentactsastheintermediarydataformatbetween resources. Onthesourcesideofthesynchronization,usethecreateXReferenceservicetocreatethe canonicalkeyforthecanonicaldocumentandestablishacrossreferencebetweenthe recordinthesourceapplicationandthecanonicaldocument.Beforepublishingthe canonicaldocument,linkthegeneratedcanonicalKeytothecanonicaldocument. Onthetargetsideofsynchronization,usethe pub.synchronization.xref:insertXReference servicetoinsertthecrossreferencebetweenacanonicalkeyandthenativeIDforthe recordinthetargetresource. FormoreinformationaboutusingthecreateXReferenceservicetocreate synchronizations,seethePublishSubscribeDevelopersGuide. See Also pub.synchronization.xref:insertXReference
pub.synchronization.xref:deleteByObjectId
WmPublic.Removesallcrossreferencerecordsassociatedwithaparticularprocessor synchronization. Input Parameters objectId StringAuniqueidentifierfortheobjectorprocessforwhichyouwant todeleteallcrossreferencerecords.Typically,theobjectIdfieldissetto thenameofthebusinessprocessforwhichyouareperforming synchronization,suchasorderorcustomer.
529
Usage Notes Youcanusethisservicetopurgeunwantedcrossreferencerecordsfromthecross referencetable.Forexample,ifyouwantedtodeleteallcrossreferencerecordsfor thepurchaseOrdersynchronization,specifypurchaseOrderastheobjectId.
pub.synchronization.xref:deleteXReference
WmPublic.Deletesacrossreferencerecordfromthecrossreferencetable. Thisservicedeletesonlyonecrossreferencerecord. Input Parameters appId canonicalKey objectId StringAuniqueidentifierfortheresource(application)forwhichyou wanttodeleteacrossreferencerecord. StringThecanonicalkey.Auniqueidentifierforthecanonical documentforwhichyouwanttodeleteacrossreference. StringAuniqueidentifierfortheobjectorprocessforwhichyouwant todeleteacrossreference.Typically,theobjectIdfieldissettothename ofthebusinessprocessforwhichyouareperformingsynchronization, suchasorderorcustomer.
pub.synchronization.xref:getCanonicalKey
WmPublic.RetrievesthecanonicalkeyforaspecifiednativeID. Input Parameters appId nativeId objectId StringAuniqueidentifierfortheresource(application)thatcontains thenativeIDforwhichyouwanttoretrieveacanonicalkey. StringAuniqueidentifierfortheresourcerecordforwhichyouwant toobtainthecanonicalkey. StringAuniqueidentifierfortheobjectorprocessbeingsynchronized. Typically,theobjectIdfieldissettothenameofthebusinessprocessfor whichyouareperformingsynchronization,suchasorderor customer.
530
Output Parameters canonicalKey StringThecanonicalkeyfortheprovidednativeID.Iftherequested keycannotbefoundordoesnotexistinthecrossreferencetable,an emptystringisreturned.
Usage Notes Youcanusethisservicetodeterminewhetheryouneedtoinsertorupdatearecordin theresource. Ifthecanonicalkeyexists(canonicalKeycontainsavalue),acrossreference betweenthenativeIDandthecanonicalkeyalreadyexists.Therecordwiththe specifiednativeIdisnotanewrecord.Youcantheninvokethe pub.synchronization.latch:isLatchClosedservicetodeterminewhethertheresource needstobeupdated. Ifthecanonicalkeydoesnotexist(canonicalKeycontainsanemptystring),then therecordwiththenativeIDisanewrecord.Youcanusethe pub.synchronization.xref:createXReferenceservicetogeneratethecanonicalkeyand createthecrossreferencetothenativeID. FormoreinformationaboutusingthegetCanonicalKeyserviceinsynchronizations,see thePublishSubscribeDevelopersGuide. See Also pub.synchronization.latch:isLatchClosed pub.synchronization.xref:createXReference
pub.synchronization.xref:getNativeId
WmPublic.RetrievesthenativeIDofaresourcerecordassociatedwithacanonicalkey. Input Parameters appId canonicalKey objectId StringAuniqueidentifierfortheresourcefromwhichyouwantto retrievethenativeIDassociatedwiththeprovidedcanonicalkey. StringThecanonicalkeyforwhichyouwanttoobtainthe correspondingnativeID. StringAuniqueidentifierfortheobjectorprocessbeingsynchronized. Typically,theobjectIdfieldissettothenameofthebusinessprocessfor whichyouareperformingsynchronization,suchasorderor customer.
531
Output Parameters nativeId StringAuniqueidentifierfortheresourcerecordassociatedwiththe providedcanonicalkey.IftherequestednativeIdcannotbefoundinthe crossreferencetable,anemptystringisreturned.
Usage Notes YoucanusethegetNativeIDserviceonthetargetsideofasynchronizationtodetermine iftherecordinthetargetresourceneedstobeinsertedorjustupdated. IfthenativeIDdoesnotexist(thenativeIdfieldcontainsanemptystring)andyou specifiedthecorrectinputvalues,thentherecorddoesnotexistintheresource. YouwillneedtoinserttherecordintheresourcetogeneratethenativeID.Then usethepub.synchronization.xref:insertXReferenceservicetoinsertacrossreference betweenthenativeIDandthecanonicalkey. IfthenativeIDexists(thenativeIdfieldcontainsavalue),thenacrossreference betweenthecanonicalkeyandtherecordalreadyexists.Therecordalreadyexists intheresourceandonlyneedstobeupdated. Afteryouinsertorupdatetherecordintheresource,makesuretouse pub.synchronization.latch:closeLatchtoclosethelatchfortherecordtopreventcircular updates(echoes). FormoreinformationaboutusingthegetNativeIdserviceinsynchronizations,seethe PublishSubscribeDevelopersGuide. See Also pub.synchronization.latch:closeLatch pub.synchronization.xref:insertXReference
pub.synchronization.xref:insertXReference
WmPublic.InsertsacrossreferencebetweenanativeIDandacanonicalkey. Input Parameters appId nativeId canonicalKey objectId StringAuniqueidentifierfortheresourceforwhichyouwantto establishacrossreferencebetweenanativeIDandacanonicalkey. StringAuniqueidentifierfortheresourcerecordwithwhichyouwant toestablishacrossreferencetocanonicalKey. StringThecanonicalkeywithwhichyouwanttoestablishacross referencetonativeId. StringAuniqueidentifierfortheobjectorprocessbeingsynchronized. Typically,theobjectIdfieldissettothenameofthebusinessprocessfor whichyouareperformingsynchronization,suchasorderor customer.
532
Output Parameters None. Usage Notes Usethisserviceonthetargetsideofasynchronizationtocreateacrossreference betweenthenewrecordinthetargetresourceandthecanonicaldocument. MostresourcesgenerateauniqueIDforanewrecord.InvoketheinsertXReference serviceafteryouaddthenewrecordintheresource. AfteryouinsertthecrossreferencebetweenthenewnativeIDandthecanonicalkey, usepub.synchronization.latch:closeLatchtoclosethelatchfortherecordtopreventcircular updates(echoes). FormoreinformationaboutusingtheinsertXReferenceserviceinsynchronizations,see thePublishSubscribeDevelopersGuide. See Also pub.synchronization.latch:closeLatch pub.synchronization.xref:createXReference
533
534
32
Trigger Folder
Youcanusetheservicesinthetriggerfoldertocreateanddeletetriggersandmanage documentretrievalanddocumentprocessingforindividualBroker/localtriggers.You canalsouseservicestoenable,disable,orsuspendoneormoreJMStriggers. Note: ABroker/localtriggerisatriggerthatsubscribestoandprocessesdocuments published/deliveredlocallyortotheBroker.AJMStriggerisatriggerthatreceives messagesfromaDestination(queueortopic)onaJMSproviderandthenprocesses thosemessages.
535
32 Trigger Folder

Thefollowingelementsareavailableinthisfolder: Element pub.trigger:createTrigger pub.trigger:deleteTrigger pub.trigger:disableJMSTriggers pub.trigger:enableJMSTriggers pub.trigger:resourceMonitoringSpec pub.trigger:resumeProcessing pub.trigger:resumeRetrieval pub.trigger:suspendJMSTriggers pub.trigger:suspendProcessing pub.trigger:suspendRetrieval Package and Description WmPublic.CreatesaBroker/localtrigger. WmPublic.DeletesaBroker/localtrigger. WmPublic.DisablesoneormoreJMStriggers. WmPublic.EnablesoneormoreJMStriggers. WmPublic.Specificationforthesignatureofa resourcemonitoringservice. WmPublic.Resumesdocumentprocessingforthe specifiedBroker/localtrigger. WmPublic.Resumesretrievalofdocumentsfromthe BrokerforaspecificBroker/localtrigger. WmPublic.SuspendsoneormoreJMStriggers. WmPublic.Suspendsdocumentprocessingforthe specifiedBroker/localtrigger. WmPublic.Suspendsretrievalofdocumentsfrom theBrokerforaspecificBroker/localtrigger.
pub.trigger:createTrigger
WmPublic.CreatesaBroker/localtrigger. Input Parameters triggerName StringFullyqualifiednameforthenewtriggerthatusesanycombination ofletters,and/ortheunderscorecharacter.Makesuretospecifythename ofthefolderandsubfolderinwhichyouwanttosavethetrigger. Note: Foralistofreservedwordsandsymbolsforelementnames,seethe webMethodsDeveloperUsersGuide. package StringNameofthepackageinwhichyouwanttosavethetrigger.
536
32 Trigger Folder
properties
DocumentOptional.Propertiesthatyouwanttoassigntothetrigger. Key joinTimeOut Description StringNumberofmillisecondsIntegrationServer waitsfortheotherdocumentsinthejoin condition.IntegrationServerstartsthejointime outperiodwhenitpullsthefirstdocumentthat satisfiesthejoinconditionfromthetriggerqueue. Youneedtospecifyajointimeoutonlywhenyour conditionisanANDor XORjointype.Youdonot needtospecifyajointimeoutforanOR join conditionoraconditionthatdoesnotusejoins. SetjoinTimeOutto-1toindicatethatthejoin conditionneverexpires. Thedefaultis1day. queueCapacity StringMaximumnumberofdocumentsthat IntegrationServermaintainsinthequeueforthis trigger. Thedefaultis10. queueRefillLevel StringNumberofunprocesseddocumentsthat mustremaininthetriggerqueuebefore IntegrationServerretrievesmoredocumentsfor thetriggerfromtheBroker. Thedefaultis4. ThequeueRefillLevelvaluemustbelessthanor equaltothequeueCapacityvalue ackQueueSize StringMaximumnumberofpendingdocument acknowledgementsforthetrigger.Thevaluemust begreaterthanzero. Thedefaultis1. maxRetryAttempts StringMaximumnumberoftimesIntegration Servershouldattempttoreexecutethetrigger service.Ifyouwantthetriggerservicetoretry untilitexecutessuccessfully,specify-1. Thedefaultis5retries. retryInterval StringNumberofsecondsIntegrationServerwaits betweenretryattempts. Thedefaultis10seconds.
537
32 Trigger Folder
onRedeliveryFailure
StringSpecifieshowIntegrationServerhandles retryfailureforthetrigger.Retryfailureoccurs whenIntegrationServerreachesthemaximum numberofretryattemptsandthetriggerservice stillfailsbecauseofaruntimeexception. Specifyoneofthefollowingvalues: Set to...

Throw Exception
To... IndicatethatIntegrationServer throwsaserviceexceptionwhenthe lastallowedretryattemptends becauseofaruntimeexception. Thisisthedefault.
Suspend and Retry Later
IndicatethatIntegrationServer suspendsthetriggerwhenthelast allowedretryattemptendsbecause ofaruntimeexception.Integration Serverretriesthetriggerserviceata latertime. Note: IfyousetonRedeliveryFailureto SuspendandRetrylater,youmust specifyaserviceforthe resumeTaskSvcNameparameter.If youdonotspecifyaserviceandthe triggersuspendsbecauseofretry failure,IntegrationServerwillnot resumethetriggerautomatically. Youmustresumethetrigger manually.
resumeTaskSvcName
StringFullyqualifiednameoftheservicethat IntegrationServerexecuteswhenoneofthe followingoccurs: Duringexactlyonceprocessing,thedocument resolverserviceendsbecauseofatransient error.IntegrationServersuspendsthetrigger andinvokestheresumeTaskSvcNameto determinewhentheresourcesassociatedwith thedocumentresolverserviceareavailable. Aftertheresourcesbecomeavailable, IntegrationServerresumesdocumentretrieval anddocumentprocessingforthetrigger.
538
32 Trigger Folder
Atriggerendsbecauseofretryfailureandthe onRedeliveryFailurevariableissettoSuspend and Retry Later.IntegrationServerexecutes theresumeTaskSvcNametodeterminewhether theresourcesassociatedwithatriggerservice areavailable.Iftheresourcesareavailable, IntegrationServerresumesdocumentretrieval anddocumentprocessingforthetrigger. isConcurrent StringIndicateswhetherthetriggerusesa concurrentprocessingmodeoraserialprocessing mode.Specifyoneofthefollowingvalues: Set to...
true
To... Specifyaconcurrentprocessing mode.IntegrationServerprocesses asmanydocumentsinthetrigger queueasitcanatonce. Specifyaserialprocessingmode. IntegrationServerprocesses documentsinthetriggerqueueone aftertheother. Thisisthedefault.
false
serialSuspendOnError
StringIndicateswhetherIntegrationServer suspendsdocumentprocessinganddocument retrievalautomaticallywhenatriggerserviceends withanerror. Set to...

true
To... IndicatethatIntegrationServer suspendsthetriggerautomaticallyif anerroroccursduringtrigger serviceexecution. IndicatethatIntegrationServer shouldnotsuspendatriggerifan erroroccursduringtriggerservice execution. Thisisthedefault
false
maxExecutionThreads
StringMaximumnumberofdocumentsthat IntegrationServercanprocessconcurrentlyfor thistrigger.IntegrationServerusesoneserver threadtoprocesseachdocumentinthetrigger queue.
539
32 Trigger Folder
dupDetection
StringIndicateswhetherIntegrationServer performsexactlyonceprocessingforguaranteed documentsreceivedbythistrigger. Set to...

true
To... IndicatethatIntegrationServer performsexactlyonceprocessing forguaranteeddocumentsreceived bythistrigger. Indicatethatexactlyonce processingisnotperformed. Thisisthedefault.
false
dupHistory
StringIndicateswhetherIntegrationServerusesa documenthistorydatabaseaspartofperforming exactlyonceprocessing. Set to...

true
To... IndicatethatIntegrationServeruses adocumenthistorydatabaseaspart ofexactlyonceprocessing. IndicatethatIntegrationServerdoes notuseadocumenthistorydatabase aspartofexactlyonceprocessing. Thisisthedefault
false
dupHistoryTTL
StringNumberofmillisecondsthatthedocument historydatabasemaintainsanentryfora documentprocessedbythistrigger. Thedefaultis2hours. StringFullyqualifiednameoftheserviceusedto determineconclusivelywhetheradocuments statusisNew,Duplicate,orInDoubt.
dupResolverSvcName
540
32 Trigger Folder
conditions
Document ListOptional.Specifiestheconditionsforthetrigger.Acondition associatesoneormorepublishabledocumenttypeswithasingleservice. Thepublishabledocumenttypeactsasthesubscriptionpieceofthetrigger. Theserviceistheprocessingpiece.Whenthetriggerreceivesdocumentsto whichitsubscribes,theIntegrationServerprocessesthedocumentby invokingtheservicespecifiedinthecondition.Triggerscancontain multipleconditions;however,atriggercancontainonlyonejoincondition. Note: Theorderinwhichyoulistconditionsintheconditionslistis importantbecauseitindicatestheorderinwhichIntegrationServer evaluatestheconditionsatruntime.WhenIntegrationServerreceivesa document,itinvokestheservicespecifiedinthefirstconditionthatis satisfiedbythedocument.Theremainingconditionsareignored.Formore informationabouttheorderinwhichconditionsareevaluated,seethe PublishSubscribeDevelopersGuide. Key conditionName Description StringNameyouwanttoassigntothecondition. Bydefault,IntegrationServerassignseach conditionadefaultnamesuchasCondition1or Condition2. serviceName StringFullyqualifiednameoftheservicethattobe invokedwhenthetriggerreceivesdocumentsor messagestowhichitsubscribes. StringThejointypeforthecondition.Thejointype determineswhetherIntegrationServerneedsto receiveall,any,oronlyoneofthedocumentsor messagesintheconditiontoexecutethetrigger service YoumustspecifyajoinTypeifthecondition subscribestomorethanonedocumenttypeor message.Thatis,ifmessageTypeFilterPairscontains morethanonepair,youmustselectajoinType. Specifyoneofthefollowing: Set to...
N/A
joinType
To... Indicatethisisnotajoincondition.
541
32 Trigger Folder
AND
IntegrationServerinvokesthe triggerservicewhentheserver receivesaninstanceofeach specifiedmessagetypewithinthe jointimeoutperiod.Theinstance documentsmusthavethesame activationID. Thisisthedefaultjointype.
OR
IntegrationServerinvokesthe associatedtriggerservicewhenit receivesaninstanceofanyoneof thespecifiedpublishabledocument types. IntegrationServerinvokesthe associatedtriggerservicewhenit receivesaninstanceofanyofthe specifieddocumenttypes.Forthe durationofthejointimeoutperiod, IntegrationServerdiscards(blocks) anyinstancesofthespecified publishabledocumenttypeswith thesameactivationID.
XOR
messageTypeFilterPairs
Document ListSpecifiesthemessagesanddocument typestowhichatriggersubscribesandthefilter thatmustbeappliedtoinstancesofthemessageor documenttype Key messageType Description StringFullyqualifiednameofthe publishabledocumenttypeor messagetowhichthetrigger subscribes.
542
32 Trigger Folder
filter
StringFilterthatyouwant IntegrationServertoapplytoeach instanceofthismessage.Integration Serverexecutesthetriggerservice onlyifinstancesofthemessage meetthefiltercriteria.Filtersare optionalforatriggercondition.For moreinformationaboutfilters,see thePublishSubscribeDevelopers Guide. Note: Ifmultipleconditionsinthe triggerspecifythesamedocument typeormessage,thefiltermustbe thesameintheconditions.Ifthe filtersarenotthesame,Integration Serverignoresthecondition.
Note: IfyouspecifymultiplemessageTypevaluesin onecondition,youneedtoselectajoinType. Output Parameters None. Usage Notes Theclientexecutingthisservicemusthavewriteaccesstothefoldersandpackagesin whichtheclientwantstosavethenewBroker/localtrigger.Iftheclientdoesnothave writeaccess,IntegrationServerthrowsawritepermissionserror.Formore informationaboutassigningaccesspermissionstofoldersandpackages,seethe webMethodsDeveloperUsersGuide. IfyouareconnectedtoaBroker,IntegrationServerregistersthetriggersubscription withtheBrokerbycreatingaclientforthetriggerontheBroker.IntegrationServer alsocreatesasubscriptionforeachmessageTypespecifiedinthetriggerconditionsand savesthesubscriptionswiththetriggerclient. IfyouarenotconnectedtoaBrokerwhenyousavethetrigger,thetriggerwillonly receivedocumentspublishedlocally.WhenyoureconnecttoaBroker,thenexttime IntegrationServerrestarts,IntegrationServerwillcreateaclientforthetriggeronthe Brokerandcreatesubscriptionsforthepublishabledocumenttypesidentifiedinthe triggerconditions.Brokervalidatesthefiltersinthetriggerconditionswhen IntegrationServercreatesthesubscriptions. IfmessageTypespecifiesapublishabledocumenttypethatdoesnotexistontheBroker (thatis,thereisnoassociatedBrokerdocumenttype),IntegrationServerstillcreates thetriggerclientontheBroker,butdoesnotcreateanysubscriptions.Integration
543
32 Trigger Folder
Servercreatesthesubscriptionswhenyousynchronize(push)thepublishable documenttypewiththeBroker. FormoreinformationaboutcreatingBroker/localtriggers,seethePublishSubscribe DevelopersGuide. See Also pub.trigger:deleteTrigger
pub.trigger:deleteTrigger
WmPublic.DeletesaBroker/localtrigger. Input Parameters triggerName Output Parameters None. Usage Notes Thetriggermustbeunlockedforthisservicetoexecutesuccessfully.Ifthetriggeris lockedwhenthisserviceexecutes,IntegrationServerthrowsanerrorstatingTrigger islocked,changenotpermitted. See Also pub.trigger:createTrigger StringFullyqualifiednameoftheBroker/localtriggerthatyou wanttodelete.
544
32 Trigger Folder
pub.trigger:disableJMSTriggers
WmPublic.DisablesoneormoreJMStriggers. Input Parameters triggerNameList applyChangeAcrossCluster String ListSpecifiestheJMStriggersthatyouwantto disable. StringOptional.FlagindicatingwhetherthespecifiedJMS triggersshouldbedisabledacrossalltheserversinthe cluster. Set to...
true
To... DisablethespecifiedJMStriggersonallthe nodesinthecluster. Note: Tomakethestatechangeonallthe serversinacluster,IntegrationServermust belongtoaproperlyconfiguredclusterandit mustbeconfiguredtosynchronizetrigger changesacrossthecluster.Formore informationaboutconfiguringanIntegration Servertosynchronizetriggermanagement changesacrossacluster,seethewebMethods IntegrationServerAdministratorsGuide.
false
Default.DisabletheJMStriggersonthelocal IntegrationServeronly.
Output Parameters None. Usage Notes WhenaJMStriggerisdisabled,theJMStriggerisstopped.IntegrationServerneither retrievesnorprocessesmessagesfortheJMStrigger. WhenyoudisableaJMStriggerthathasanondurablesubscriber,theJMSprovider willremoveanymessagesfortheJMStrigger. WhenyoudisableaJMStrigger,IntegrationServerdoesthefollowing: IftheJMStriggeriswaitingbeforemakingaretryattempt,IntegrationServer interruptsprocessingfortheJMStrigger. IftheJMStriggeriscurrentlyprocessingmessages,IntegrationServerwaitsa specifiedamountoftimebeforeforcingtheJMStriggertostopprocessing messages.Ifitdoesnotcompleteintheallottedtimethemessageconsumerused toreceivemessagesfortheJMStriggerisstoppedandtheJMSsessionisclosed.
545
32 Trigger Folder
AtthispointtheserverthreadfortheJMStriggercontinuestoruntocompletion. However,theJMStriggerwillnotbeabletoacknowledgethemessagewhen processingcompletes.Ifthemessageisguaranteed(PERSISTENT),thiscanlead toduplicatemessages. ThetimeIntegrationServerwaitsbetweentherequesttodisabletheJMStrigger andforcingthetriggertostopisspecifiedbythe watt.server.jms.trigger.stopRequestTimeoutproperty Becauseadministeredobjects,likedestinations,areconfiguredoutsideofIntegration Server,disablingaJMStriggerhasnoimpactonthesubscription. Usethepub.trigger:enableJMSTriggersservicetoenableoneormoreJMStriggers. Usethepub.trigger:suspendJMSTriggersservicetosuspendoneormoreJMStriggers. YoucanalsousetheSettings > Messaging JMS Trigger ManagementscreensinIntegration ServerAdministratortodisable,enable,andsuspendJMStriggers.Formore information,seethewebMethodsIntegrationServerAdministratorsGuide. IfyousetapplyChangeAcrossClustertotrueandthesynchronizationisnotsuccessful, thefollowingoccurs: IfIntegrationServerdoesnotupdatealltheIntegrationServersinthecluster successfully,theIntegrationServerwritesthefollowingserverlogentryforeach serverthatcouldnotbeupdated:[ISS.0098.0107E] Error occurred during cluster invoke: Alias = remoteAliasName; Service = serviceName; Exception = exceptionName TheIntegrationServerAdministratoralsodisplaysthefollowingmessage:
[ISS.0085.9203] Errors occurred while updating remote aliases (x of y updates failed). See server logs for more details.
IfIntegrationServercannotupdatetheIntegrationServersintheclusterbecause thechangecouldnotbemadelocally,theIntegrationServerAdministrator displaysthefollowingmessage: [ISS.0085.9204] Local update failed:

Exception providing reason for failure. (Note: The cluster synchronization will not run until all local errors are resolved.)
IfIntegrationServercannotupdatetheotherIntegrationServersinthecluster becauseclustersynchronizationisnotconfigured,theIntegrationServerwrites thefollowingserverlogentry:[ISS.0033.0156W] Cluster invoke did not

complete successfully. Cluster Synchronization feature is not configured.
See Also pub.trigger:enableJMSTriggers pub.trigger:suspendJMSTriggers
546
32 Trigger Folder
pub.trigger:enableJMSTriggers
WmPublic.EnablesoneormoreJMStriggers. Input Parameters triggerNameList applyChangeAcrossCluster String ListSpecifiestheJMStriggersthatyouwantto enable. StringOptional.FlagindicatingwhetherthespecifiedJMS triggersshouldbeenabledacrossalltheserversinthe cluster. Set to...
true
To... EnablethespecifiedJMStriggersonallthe nodesinthecluster. Note: Tomakethestatechangeonallthe serversinacluster,theIntegrationServer mustbelongtoaproperlyconfigured clusteranditmustbeconfiguredto synchronizetriggerchangesacrossthe cluster.Formoreinformationabout configuringanIntegrationServerto synchronizetriggermanagementchanges acrossacluster,seethewebMethods IntegrationServerAdministratorsGuide.
false
Default.EnabletheJMStriggersonthe localIntegrationServeronly.
Output Parameters None. Usage Notes WhenaJMStriggerisenabled,theJMStriggerisrunningandconnectedtotheJMS provider.IntegrationServerretrievesandprocessesmessagesfortheJMStrigger. YoucanalsousetheSettings > Messaging JMS Trigger ManagementscreensinIntegration ServerAdministratortodisable,enable,andsuspendJMStriggers.Formore information,seethewebMethodsIntegrationServerAdministratorsGuide. Youcanusethepub.trigger:disableJMSTriggersservicetodisableoneormoreJMStriggers. Usethepub.trigger:suspendJMSTriggersservicetosuspendoneormoreJMStriggers. IfyousetapplyChangeAcrossClustertotrueandthesynchronizationisnotsuccessful, thefollowingoccurs:
547
32 Trigger Folder
IfIntegrationServerdoesnotupdatealltheIntegrationServersinthecluster successfully,theIntegrationServerwritesthefollowingserverlogentryforeach serverthatcouldnotbeupdated:[ISS.0098.0107E] Error occurred during cluster invoke: Alias = remoteAliasName; Service = serviceName; Exception = exceptionName TheIntegrationServerAdministratoralsodisplaysthefollowingmessage:
IfIntegrationServercannotupdatetheIntegrationServersintheclusterbecause thechangecouldnotbemadelocally,theIntegrationServerAdministrator displaysthefollowingmessage: [ISS.0085.9204] Local update failed:

IftheIntegrationServercannotupdatetheIntegrationServersinthecluster becauseclustersynchronizationisnotconfigured,theIntegrationServerwrites thefollowingserverlogentry:[ISS.0033.0156W] Cluster invoke did not

YoucanusetheIntegrationServerAdministratortoviewandchangecluster synchronizationstatusfortriggers.Formoreinformation,seethewebMethods IntegrationServerAdministratorsGuide. See Also pub.trigger:disableJMSTriggers pub.trigger:suspendJMSTriggers
pub.trigger:resourceMonitoringSpec
WmPublic.Specificationforthesignatureofaresourcemonitoringservice. Input Parameters None.
548
32 Trigger Folder
Output Parameters isAvailable StringIndicateswhethertheresourcesneededbythetrigger (Broker/localorJMS)toperformexactlyonceprocessingorto executethetriggerserviceareavailable.Thevalueofthisfield determineswhetherIntegrationServerresumesthetriggerorre executestheresourcemonitoringservice.IntegrationServer continuestoexecutearesourcemonitoringserviceuntilthevalueof isAvailableistrue.TheisAvailablefieldmusthaveoneofthe followingvalues: Value
true
Description Indicatesthattheresourcesassociatedwiththetrigger areavailable.ForaBroker/localtrigger,Integration Serverresumesdocumentretrievalanddocument processingforthetrigger.ForaJMStrigger,Integration Serverenablesthetrigger. Indicatesthattheresourcesassociatedwiththetrigger arenotavailable.IntegrationServerwillnotresumethe trigger.
false
Usage Notes Thepub.trigger:resourceMonitoringSpecmustbeusedastheservicesignatureforany serviceusedasaresourcemonitoringservice.Aresourcemonitoringservicedetermines whethertheresourcesassociatedwithatrigger(Broker/localorJMS)areavailablefor exactlyonceprocessingordocumentpreprocessing.IntegrationServerexecutesa resourcemonitoringserviceafterretryfailureoccursforthetriggerorwhenthe documentresolverservicefailsbecauseofaruntimeexception.Formore informationaboutbuildingaresourcemonitoringservice,seethePublishSubscribe DevelopersGuide.
549
32 Trigger Folder
pub.trigger:resumeProcessing
WmPublic.ResumesdocumentprocessingforthespecifiedBroker/localtrigger. Input Parameters triggerName persistChange String. FullyqualifiednameoftheBroker/localtriggerfor whichyouwanttoresumedocumentprocessing. String. Optional.Flagindicatingwhetherthedocument processingchangeshouldbepermanentortemporary. Set to...
true
To... Savethechangetofile.IntegrationServer persiststhechangeacrossserverrestarts, packagereloads,andchangestotrigger properties.Thetriggerwillcontinuetoprocess documentsuntilitisactivelysuspendedviathe IntegrationServerAdministratororby executionofthepub.trigger:suspendProcessing service. Default.Indicatethatthechangeistemporary andwillnotbemaintainedwhentheserver restarts,thetriggerisenabledordisabled,or thepackagecontainingthetriggerreloads.
false
550
32 Trigger Folder
applyChangeAcrossCluster
String.Optional.Flagindicatingwhetherdocument processingshouldberesumedforthistriggeracrossallthe serversinthecluster. Set to...

true
To... Resumedocumentprocessingforthespecified triggeronallthenodesinthecluster. Note: Tomakethedocumentprocessingchange onalltheserversinacluster,theIntegration Servermustbelongtoaproperlyconfigured clusteranditmustbeconfiguredto synchronizetriggerchangesacrossthecluster. Formoreinformationaboutconfiguringan IntegrationServertosynchronizetrigger managementchangesacrossacluster,seethe webMethodsIntegrationServerAdministrators Guide.
false
Default.Indicatethatdocumentprocessingfor thistriggershouldberesumedonthelocal IntegrationServeronly.
Output Parameters None. Usage Notes ThisserviceaffectsalldocumentsinthespecifiedtriggerqueueontheIntegration Server,includingdocumentsretrievedfromtheBrokerandfromlocalpublishing. Ifyoudonotpersistthechange,thetriggerrevertstothepreviouslysaveddocument processingstatewhentheIntegrationServerrestarts,thetriggerisenabledor disabled,orthepackagecontainingthetriggerreloads. Afterthisserviceexecutes,theIntegrationServerresumesdocumentprocessingfor thistriggeratthepercentagespecifiedintheExecution Threads Throttlefieldonthe Settings > Resources > Trigger Management > Edit Global Trigger Controlspageinthe IntegrationServerAdministrator. IntegrationServerresumesdocumentprocessingforthespecifiedtriggerevenif documentprocessingissuspendedforalltriggersontheIntegrationServer(thatis, theProcessing StateforalltriggersissettoSuspended). IntegrationServerwillnotresumedocumentprocessingforthespecifiedtriggerif thetriggerislockedbyauser.Formoreinformationaboutlockingelements,seethe webMethodsDeveloperUsersGuide.
551
32 Trigger Folder
IfyousetapplyChangeAcrossClustertotrueandthesynchronizationisnotsuccessful, thefollowingoccurs: IftheIntegrationServerdoesnotupdatealltheIntegrationServersinthecluster successfully,theIntegrationServerwritesthefollowingserverlogentryforeach serverthatcouldnotbeupdated:[ISS.0098.0107E] Error occurred during cluster invoke: Alias = remoteAliasName; Service = serviceName; Exception = exceptionName TheIntegrationServerAdministratoralsodisplaysthefollowingmessage:
IftheIntegrationServercannotupdatetheIntegrationServersinthecluster becausethechangecouldnotbemadelocally,theIntegrationServer Administratordisplaysthefollowingmessage:[ISS.0085.9204] Local update

failed: Exception providing reason for failure. (Note: The cluster synchronization will not run until all local errors are resolved.)

YoucanusetheIntegrationServerAdministratortoviewandchangecluster synchronizationstatusfortriggers.Formoreinformation,seethewebMethods IntegrationServerAdministratorsGuide. InaJavaservice,youcanresumedocumentprocessingusing com.wm.app.b2b.server.dispatcher.trigger.TriggerFacade.setProcessingSuspended(). Formoreinformationaboutthismethod,seethewebMethodsIntegrationServerJava APIReferenceforthecom.wm.app.b2b.server.dispatcher.trigger.TriggerFacadeclass. Youcanresumeandsuspenddocumentprocessingforanindividualtriggerorall triggersusingtheIntegrationServerAdministrator.Formoreinformation,seethe webMethodsIntegrationServerAdministratorsGuide. See Also pub.trigger:suspendProcessing
552
32 Trigger Folder
pub.trigger:resumeRetrieval
WmPublic.ResumesretrievalofdocumentsfromtheBrokerforaspecificBroker/local trigger. Input Parameters triggerName persistChange String. FullyqualifiednameoftheBroker/localtriggerfor whichyouwanttoresumedocumentretrieval. String. Optional.Flagindicatingwhetherthedocument retrievalchangeshouldbepermanentortemporary. Set to...
true
To... Savethechangetofile.IntegrationServer persiststhechangeacrossserverrestarts, packagereloads,andchangestotrigger properties.Thetriggerwillcontinuetoretrieve documentsuntilitisactivelysuspendedviathe IntegrationServerAdministratororby executionofthepub.trigger:suspendRetrieval service. Default.Indicatethatthechangeistemporary andwillnotbemaintainedwhentheserver restarts,thetriggerisenabledordisabled,or thepackagecontainingthetriggerreloads.
false
553
32 Trigger Folder
String.Optional.Flagindicatingwhetherdocument retrievalshouldberesumedforthistriggeracrossallthe serversinthecluster. Set to...

true
To... Resumedocumentretrievalforthespecified triggeronalltheserversinthecluster. Note: Tomakethedocumentretrievalchangeon alltheserversinacluster,theIntegrationServer mustbelongtoaproperlyconfiguredcluster anditmustbeconfiguredtosynchronize triggerchangesacrossthecluster.Formore informationaboutconfiguringanIntegration Servertosynchronizetriggermanagement changesacrossacluster,seethewebMethods IntegrationServerAdministratorsGuide.
false
Default.Indicatethatdocumentretrievalfor thistriggershouldberesumedonthelocal IntegrationServeronly.
Output Parameters None. Usage Notes Thisservicedoesnotaffectdocumentretrievalforlocallypublisheddocumentsto whichthistriggersubscribes. Ifyoudonotpersistthechange,thetriggerrevertstothepreviouslysaveddocument retrievalstatewhentheserverrestarts,thetriggerisenabledordisabled,orthe packagecontainingthetriggerreloads. Afterthisserviceexecutes,theIntegrationServerresumesdocumentretrievalforthis triggeratthepercentagespecifiedintheQueue Capacity ThrottlefieldontheSettings > Resources > Trigger Management > Edit Global Trigger ControlspageintheIntegration ServerAdministrator. TheIntegrationServerresumesdocumentretrievalforthespecifiedtriggerevenif documentretrievalissuspendedforallthetriggersontheIntegrationServer(thatis, theRetrieval StateforalltriggersissettoSuspended). TheIntegrationServerwillnotresumedocumentretrievalforthespecifiedtriggerif thetriggerislockedbyauser.Formoreinformationaboutlockingelements,seethe webMethodsDeveloperUsersGuide.
554
32 Trigger Folder
IfyousetapplyChangeAcrossClustertotrueandthesynchronizationisnotsuccessful, thefollowingoccurs: IftheIntegrationServerdoesnotupdatealltheIntegrationServersinthecluster successfully,theIntegrationServerwritesthefollowingserverlogentryforeach serverthatcouldnotbeupdated:[ISS.0098.0107E] Error occurred during cluster invoke: Alias = remoteAliasName; Service = serviceName; Exception = exceptionName TheIntegrationServerAdministratoralsodisplaysthefollowingmessage:


YoucanusetheIntegrationServerAdministratortoviewandchangecluster synchronizationstatusfortriggers.Formoreinformation,seethewebMethods IntegrationServerAdministratorsGuide InaJavaservice,youcanresumedocumentretrievalbycalling com.wm.app.b2b.server.dispatcher.trigger.TriggerFacade.setRetrievalSuspended(). Formoreinformationaboutthismethod,seethewebMethodsIntegrationServerJava APIReferenceforthecom.wm.app.b2b.server.dispatcher.trigger.TriggerFacadeclass. Youcanresumeandsuspenddocumentretrievalforanindividualtriggerorall triggersusingtheIntegrationServerAdministrator.Formoreinformation,seethe webMethodsIntegrationServerAdministratorsGuide. See Also pub.trigger:suspendRetrieval
555
32 Trigger Folder
pub.trigger:suspendJMSTriggers
WmPublic.SuspendsoneormoreJMStriggers. Input Parameters triggerNameList applyChangeAcrossCluster String ListSpecifiestheJMStriggersthatyouwantto suspend. StringOptional.FlagindicatingwhetherthespecifiedJMS triggersshouldbesuspendedacrossalltheserversinthe cluster. Set to...
true
To... SuspendthespecifiedJMStriggersonall thenodesinthecluster. Note: Tomakethestatuschangeonallthe serversinacluster,theIntegrationServer mustbelongtoaproperlyconfigured clusteranditmustbeconfiguredto synchronizetriggerchangesacrossthe cluster.Formoreinformationabout configuringanIntegrationServerto synchronizetriggermanagementchanges acrossacluster,seethewebMethods IntegrationServerAdministratorsGuide.
false
Default.SuspendtheJMStriggersonthe localIntegrationServeronly.
Output Parameters None. Usage Notes WhenaJMStriggerissuspended,theJMStriggerisrunningandconnectedtothe JMSprovider.IntegrationServerhasstoppedmessageretrieval,butcontinues processinganymessagesithasalreadyretrieved IfaJMStriggerisprocessingmessageswhenthisserviceexecutes,theJMStrigger willcompleteprocessing.JMStriggeralsoacknowledgesthemessagestotheJMS provider. AfterasuspendingaJMStrigger,IntegrationServerwillnotstartprocessingforany additionalmessagesalreadyreceivedbytheJMStrigger. Usethepub.trigger:disableJMSTriggersservicetodisableoneormoreJMStriggers. Usethepub.trigger:enableJMSTriggersservicetoenableoneormoreJMStriggers.
556
32 Trigger Folder
YoucanalsousetheSettings > Messaging JMS Trigger ManagementscreensinIntegration ServerAdministratortodisable,enable,andsuspendJMStriggers.Formore information,seethewebMethodsIntegrationServerAdministratorsGuide. IfyousetapplyChangeAcrossClustertotrueandthesynchronizationisnotsuccessful, thefollowingoccurs: IfIntegrationServerdoesnotupdatealltheIntegrationServersinthecluster successfully,theIntegrationServerwritesthefollowingserverlogentryforeach serverthatcouldnotbeupdated:[ISS.0098.0107E] Error occurred during cluster invoke: Alias = remoteAliasName; Service = serviceName; Exception = exceptionName TheIntegrationServerAdministratoralsodisplaysthefollowingmessage:
IfIntegrationServercannotupdatetheIntegrationServersintheclusterbecause thechangecouldnotbemadelocally,theIntegrationServerAdministrator displaysthefollowingmessage:[ISS.0085.9204] Local update failed:

IfIntegrationServercannotupdatetheotherIntegrationServersinthecluster becauseclustersynchronizationisnotconfigured,theIntegrationServerwrites thefollowingserverlogentry:[ISS.0033.0156W] Cluster invoke did not

See Also pub.trigger:disableJMSTriggers pub.trigger:enableJMSTriggers
557
32 Trigger Folder
pub.trigger:suspendProcessing
WmPublic.SuspendsdocumentprocessingforthespecifiedBroker/localtrigger. Input Parameters triggerName persistChange String.FullyqualifiednameoftheBroker/localtriggerfor whichyouwanttosuspenddocumentprocessing. String.Optional.Flagindicatingwhetherthedocument processingchangeshouldbepermanentortemporary. Set to...
true
To... Savethechangetofile.IntegrationServer persiststhechangeacrossserverrestarts, packagereloads,andchangestotrigger properties.Thetriggerwillnotprocess documentsuntilprocessingisactivelyresumed viatheIntegrationServerAdministratororby executionofthepub.trigger:resumeProcessing service. Default.Indicatethatthechangeistemporary andwillnotbemaintainedwhentheserver restarts,thetriggerisenabledordisabled,or thepackagecontainingthetriggerreloads.
false
558
32 Trigger Folder
String.Optional.Flagindicatingwhetherdocument processingshouldbesuspendedforthistriggeracrossall theserversinthecluster. Set to...

true
To... Suspenddocumentprocessingforthespecified triggeronalltheserversinthecluster. Note: Tomakethedocumentprocessingchange onalltheserversinacluster,theIntegration Servermustbelongtoaproperlyconfigured clusteranditmustbeconfiguredto synchronizetriggerchangesacrossthecluster. Formoreinformationaboutconfiguringan IntegrationServertosynchronizetrigger managementchangesacrossacluster,seethe webMethodsIntegrationServerAdministrators Guide.
false
Default.Indicatethatdocumentprocessingfor thistriggershouldbesuspendedonthelocal IntegrationServeronly.
Output Parameters None. Usage Notes ThisserviceaffectsalldocumentsinthespecifiedtriggerqueueontheIntegration Server,includingdocumentsretrievedfromtheBrokerandfromlocalpublishing. Whenyoususpenddocumentprocessing,theIntegrationServerwillnotdispatch anymoreserverthreadstoprocessdocumentsinthetriggersqueue.Anyserver threadscurrentlyprocessingdocumentsforthetriggerwillexecutetocompletion. Thisincludesdocumentsthatarebeingretried. Whenyoususpenddocumentprocessing,documentsthatthetriggerretrieveswill collectinthetriggerqueueuntilthetriggerresumesdocumentprocessing.Ifthe serverrestartsbeforedocumentprocessingresumes,volatiledocumentsare discarded. Ifyoudonotpersistthechange,thetriggerrevertstothepreviouslysaveddocument processingstatewhentheserverrestarts,thetriggerisenabledordisabled,orthe packagecontainingthetriggerreloads. TheIntegrationServerwillnotsuspenddocumentprocessingforthespecifiedtrigger ifthetriggerislockedbyauser.Formoreinformationaboutlockingelements,seethe webMethodsDeveloperUsersGuide.
559
32 Trigger Folder
Ifyoususpenddocumentprocessing,butdonotsuspenddocumentretrievalfora trigger,thetriggerqueuefillstocapacityandIntegrationServerstopsretrieving documentsforthistriggerfromtheBroker. IfyousetapplyChangeAcrossClustertotrueandthesynchronizationisnotsuccessful, thefollowingoccurs: IftheIntegrationServerdoesnotupdatealltheIntegrationServersinthecluster successfully,theIntegrationServerwritesthefollowingserverlogentryforeach serverthatcouldnotbeupdated:[ISS.0098.0107E] Error occurred during cluster invoke: Alias = remoteAliasName; Service = serviceName; Exception = exceptionName TheIntegrationServerAdministratoralsodisplaysthefollowingmessage:


YoucanusetheIntegrationServerAdministratortoviewandchangecluster synchronizationstatusfortriggers.Formoreinformation,seethewebMethods IntegrationServerAdministratorsGuide InaJavaservice,youcansuspenddocumentprocessingbycalling com.wm.app.b2b.server.dispatcher.trigger.TriggerFacade.setProcessingSuspended(). Formoreinformationaboutthismethod,seethewebMethodsIntegrationServerJava APIReferenceforthecom.wm.app.b2b.server.dispatcher.trigger.TriggerFacadeclass. Youcanresumeandsuspenddocumentprocessingforanindividualtriggerorall triggersusingtheIntegrationServerAdministrator.Formoreinformation,seethe webMethodsIntegrationServerAdministratorsGuide. See Also pub.trigger:resumeProcessing
560
32 Trigger Folder
pub.trigger:suspendRetrieval
WmPublic.SuspendsretrievalofdocumentsfromtheBrokerforaspecificBroker/local trigger. Input Parameters triggerName persistChange String.FullyqualifiednameoftheBroker/localtriggerfor whichyouwanttosuspenddocumentretrieval. String.Optional.Flagindicatingwhetherthedocument retrievalchangeshouldbepermanentortemporary. Set to...
true
To... Savethechangetofile.IntegrationServer persiststhechangeacrossserverrestarts, packagereloads,andchangestotrigger properties.Thetriggerwillnotretrieve documentsuntilretrievalisactivelyresumed viatheIntegrationServerAdministratororby executionofthepub.trigger:resumeProcessing service. Default.Indicatethatthechangeistemporary andwillnotbemaintainedwhentheserver restarts,thetriggerisenabledordisabled,or thepackagecontainingthetriggerreloads.
false
561
32 Trigger Folder
String.Optional.Flagindicatingwhetherdocument retrievalshouldbesuspendedforthistriggeracrossallthe serversinthecluster. Set to...

true
To... Suspenddocumentretrievalforthespecified triggeronalltheserversinthecluster. Note: Tomakethedocumentretrievalchangeon alltheserversinacluster,theIntegration Servermustbelongtoaproperlyconfigured clusteranditmustbeconfiguredto synchronizetriggerchangesacrossthecluster. Formoreinformationaboutconfiguringan IntegrationServertosynchronizetrigger managementchangesacrossacluster,see webMethodsIntegrationServerAdministrators Guide.
false
Default.Indicatethatdocumentretrievalfor thistriggershouldbesuspendedonthelocal IntegrationServeronly.
Output Parameters None. Usage Notes Thisservicedoesnotaffectdocumentretrievalforlocallypublisheddocumentsto whichthespecifiedtriggersubscribes. Whenyoususpenddocumentretrieval,thespecifiedtriggerwillcontinuetoreceive documentsdeliveredtothedefaultclient. TheIntegrationServerwillnotsuspenddocumentprocessingforthespecifiedtrigger ifthetriggerislockedbyauser.Formoreinformationaboutlockingelements,seethe webMethodsDeveloperUsersGuide. Whenyoususpenddocumentretrieval,theIntegrationServerwillnotdispatchany serverthreadstoretrievedocumentsfromtheBrokerforthetrigger.Anyserver threadscurrentlyretrievingdocumentsforthetriggerwillexecutetocompletion. Whenyoususpenddocumentretrieval,documentstowhichthistriggersubscribes willcollectinthetriggersclientqueueontheBroker.Documentsremaininthe triggersclientqueueuntildocumentretrievalresumesforthetriggerorthe documentsexpire. Ifyoudonotresumedocumentretrievalbeforetheserverrestarts,thetrigger packagereloads,orthetriggerpropertiesaremodified,theBrokerdiscardsany volatiledocumentsinthattriggersclientqueue.
562
32 Trigger Folder
Ifyoudonotpersistthechange,thetriggerrevertstothepreviouslysaveddocument retrievalstatewhentheserverrestarts,thetriggerisenabledordisabled,orthe packagecontainingthetriggerreloads. Ifyoususpenddocumentretrievalforatrigger,butdonotsuspenddocument processingforthetrigger,thetriggereventuallyprocessesallthedocumentsthat wereretrievedfromtheBrokerforthetrigger. IfyousetapplyChangeAcrossClustertotrueandthesynchronizationisnotsuccessful, thefollowingoccurs: IftheIntegrationServerdoesnotupdatealltheIntegrationServersinthecluster successfully,theIntegrationServerwritesthefollowingserverlogentryforeach serverthatcouldnotbeupdated:[ISS.0098.0107E] Error occurred during cluster invoke: Alias = remoteAliasName; Service = serviceName; Exception = exceptionName TheIntegrationServerAdministratoralsodisplaysthefollowingmessage:


YoucanusetheIntegrationServerAdministratortoviewandchangecluster synchronizationstatusfortriggers.Formoreinformation,seethewebMethods IntegrationServerAdministratorsGuide InaJavaservice,youcansuspenddocumentretrievalbycalling setRetrievalSuspended().Formoreinformationaboutthismethod,seethe webMethodsIntegrationServerJavaAPIReferenceforthe com.wm.app.b2b.server.dispatcher.trigger.TriggerFacadeclass. Youcanresumeandsuspenddocumentretrievalforanindividualtriggerorall triggersusingtheIntegrationServerAdministrator.Formoreinformation,seethe webMethodsIntegrationServerAdministratorsGuide. See Also pub.trigger:resumeRetrieval
563
32 Trigger Folder
564
33
UDDI Folder
TheUDDIfolderprovidesservices,specifications,anddocumenttypesforUDDIinquiry andpublishing.Youcanusetheseelementsto: queryaboutWebserviceinformation publishanexistingIntegrationServerserviceasaWebservicetoaUDDIserver. TheUDDIservices,specifications,anddocumenttypesarecompliantwithUDDIVersion 2.04.Formoreinformation,see: UDDIVersion2.04Specification UDDIVersion2.03DataStructureReference Important! Theservicesinthisfolderhavebeendeprecated.
565
33 UDDI Folder

Thefollowingelementsareavailableinthisfolder: Element pub.uddi.client.doc:accessPoint Package and Description WmUDDI.Documenttypethatconveys theentrypointaddresssuitableforcalling aparticularWebservice. The accessPoint documenttypeisanattributequalified pointertoaserviceentrypoint. WmUDDI.Documenttypethatisa simplelistofpub.uddi.client.doc:addressLine elementswithintheaddresscontainer. WmUDDI.Documenttypethatcontains theaddresslineinformation. WmUDDI.Documenttypethatcontains theassertionstatusinformation. WmUDDI.Documenttypethatreportsall completeandincompleteassertionsand servesanadministrativeuse,including determiningifthereareanyoutstanding, incompleteassertionsaboutrelationships involvingbusinesseswithwhichthe publisheraccountisassociated. WmUDDI.Documenttypethatcontainsa singleauthInfoelementthatcontainsan accesstokenthatistobepassedbackin allPublishersAPImessagesthatchange data. WmUDDI.Documenttypethatconsists ofoneormorebindingTemplate structuresthatarereturnedaccordingto thedatarequestedintherequestmessage. WmUDDI.Documenttypethatcontainsa uniquekeyforagivenbindingTemplate. WmUDDI.Documenttypethatholds technicalservicedescriptioninformation relatedtoagivenbusinessservicefamily. WmUDDI.Documenttypethatcontains listofbindingTemplates.
pub.uddi.client.doc:address
pub.uddi.client.doc:addressLine pub.uddi.client.doc:assertionStatusItem pub.uddi.client.doc:assertionStatusReport
pub.uddi.client.doc:authToken
pub.uddi.client.doc:bindingDetail
pub.uddi.client.doc:bindingKey pub.uddi.client.doc:bindingTemplate
pub.uddi.client.doc:bindingTemplates
566
33 UDDI Folder
Element pub.uddi.client.doc:businessDetail
Package and Description WmUDDI.Documenttypethatconsists ofoneormorebusinessDetailstructures thatarereturnedaccordingtothedata requestedintherequestmessage. WmUDDI.Documenttypethatconsists ofoneormorebusinessDetailExt structuresthatarereturnedaccordingto thedatarequestedintherequestmessage. WmUDDI.Documenttypethat representsallknowninformationabouta businessorentitythatpublishes descriptiveinformationabouttheentity aswellastheservicesthatitoffers. WmUDDI.Documenttypethatcontainsa pub.uddi.client.doc:businessEntitydocument. WmUDDI.Documenttypethatcontains companynameandoptionaldescription data,alongwithacollectionelement namedserviceInfosthatinturncan containoneormoreserviceInfo structures. WmUDDI.Documenttypethatconsists oflistofbusinessInfodocuments. WmUDDI.Documenttypethatcontains theuniqueidentifierforagiveninstance ofapub.uddi.client.doc:businessEntity structure. WmUDDI.Documenttypethatcontains zeroormorebusinessInfosstructures. WmUDDI.Documenttypethat representsalogicalserviceclassification. WmUDDI.Documenttypethatliststhe businessServicedocuments. WmUDDI.Documenttypethatallows pub.uddi.client.doc:businessEntity, businessService,andtModelstructuresto becategorizedaccordingtoanyofseveral availabletaxonomybasedclassification schemes. WmUDDI.Documenttypethatletsyou recordcontactinformationforaperson.
pub.uddi.client.doc:businessDetailExt
pub.uddi.client.doc:businessEntity
pub.uddi.client.doc:businessEntityExt pub.uddi.client.doc:businessInfo
pub.uddi.client.doc:businessInfos pub.uddi.client.doc:businessKey
pub.uddi.client.doc:businessList pub.uddi.client.doc:businessService pub.uddi.client.doc:businessServices pub.uddi.client.doc:categoryBag
pub.uddi.client.doc:contact
567
33 UDDI Folder
Element pub.uddi.client.doc:contacts
Package and Description WmUDDI.Documenttypethatprovides awayforinformationtoberegistered withapub.uddi.client.doc:businessEntityrecord sothatsomeonethatfindsthe informationcanmakehumancontactfor anypurpose. WmUDDI.Documenttypethatconsists ofanattributewhosevaluedesignatesthe URLusetypeconvention,andastring, foundwithinthebodyoftheelement. WmUDDI.Documenttypethatisusedto holdpointerstoURLaddressable discoverydocuments. WmUDDI.Documenttypethatisusedto reportstatusofvariouspublish operations. WmUDDI.Documenttypethatallows pub.uddi.client.doc:businessEntity, businessServiceandtModelstructuresto becategorizedaccordingtoanyofseveral availabletaxonomybasedclassification schemes. WmUDDI.Documenttypethatcontains thedescriptionwithlanguageresource information. WmUDDI.Documenttypethat designatestherelationshiptypeforwhich theassertionismade,representedbythe includedtModelKeyanddescribedbythe includedkeyNamekeyValuepair. WmUDDI.Documenttypethatdescribes aname. WmUDDI.Documenttypethatdescribes theemailinformation. WmUDDI.Documenttypethatdescribes theerrorinformation. WmUDDI.Documenttypethatprovides ameanstoallowthecallertooverride defaultsearchbehaviors. WmUDDI.Documenttypethatcontainsa listoffindqualifiers.
pub.uddi.client.doc:discoveryURL
pub.uddi.client.doc:discoveryURLs
pub.uddi.client.doc:dispositionReport
pub.uddi.client.doc:docType_categoryBag
pub.uddi.client.doc:docType_description
pub.uddi.client.doc:docType_keyedReference
pub.uddi.client.doc:docType_name pub.uddi.client.doc:email pub.uddi.client.doc:errInfo pub.uddi.client.doc:findQualifier
pub.uddi.client.doc:findQualifiers
568
33 UDDI Folder
Element pub.uddi.client.doc:fromKey pub.uddi.client.doc:hostingRedirector
Package and Description WmUDDI.Documenttypethatcontainsa UUIDreferencetoabusinessEntity. WmUDDI.Documenttypethatisusedto designatethatabindingTemplateentryis apointertoadifferentbindingTemplate entry. WmUDDI.Documenttypethatisa generalpurposeplaceholderforany numberofdistinctidentifiers. WmUDDI.Documenttypethatholds serviceinstancespecificinformationthat isrequiredtoeitherunderstandthe serviceimplementationdetailsrelativeto aspecifictModelKeyreference,orto providefurtherparameterandsettings support. WmUDDI.Documenttypethatisusedto containsettingsparametersoraURL referencetoafilethatcontainssettingsor parametersrequiredtouseaspecificfacet ofabindingTemplatedescription. WmUDDI.Documenttypethat designatestherelationshiptypeforwhich theassertionismade,representedbythe includedtModelKeyanddescribedbythe includedkeyNamekeyValuepair. WmUDDI.Documenttypethat designatesthosebusinesskeysthe publishermanages. WmUDDI.Documenttypethatisusedto housereferencestoremotedescriptive informationorinstructionsrelatedto properuseofabindingTemplatetechnical subelement. WmUDDI.Documenttypethatisusedto holdtelephonenumbersforthecontact. WmUDDI.Documenttypethatdescribes apublisherassertionstructure.
pub.uddi.client.doc:identifierBag
pub.uddi.client.doc:instanceDetails
pub.uddi.client.doc:instanceParms
pub.uddi.client.doc:keyedReference
pub.uddi.client.doc:keysOwned
pub.uddi.client.doc:overviewDoc
pub.uddi.client.doc:phone pub.uddi.client.doc:publisherAssertion
569
33 UDDI Folder
Element pub.uddi.client.doc:publisherAssertions
Package and Description WmUDDI.Documenttypethatreturnsall assertionsmadebythepublisherwho wasauthenticatedinthepreceding set_publisherAssertionsorthe get_publisherAssertionsAPIcalls. WmUDDI.Documenttypethatcontains overviewinformationthatissuitablefor identifyingall pub.uddi.client.doc:businessEntityandtModel datapublishedbytherequester. WmUDDI.Documenttypethatcontains informationabouta pub.uddi.client.doc:businessEntitythatrelatesto thespecifiedpub.uddi.client.doc:businessEntity byatleastonerelationship. WmUDDI.Documenttypethatcontains informationabouta pub.uddi.client.doc:businessEntitythatrelatesto thespecifiedpub.uddi.client.doc:businessEntity byatleastonerelationship. WmUDDI.Documenttypethatcontains listofrelatedbusinesslists. WmUDDI.Documenttypethatdefines theresultstructure. WmUDDI.Schemacreatedusingthe webMethodsschemageneratoraspartof creatingdocumenttypes.Itiscreated fromtheXSDdocumentspecifiedby UDDIVersion2.0UDDIXMLSchema 2001. WmUDDI.Schemacreatedusingthe webMethodsschemageneratoraspartof creatingdocumenttypes.Itiscreated fromtheXSDdocumentspecifiedby UDDIVersion2.0UDDIXMLSchema 2001. WmUDDI.Documenttypethatare abbreviatedversionsofbusinessService data,suitableforpopulatingalistof servicesassociatedwithabusinessand thatmatchapatternasspecifiedinthe inputstothefind_serviceAPI.
pub.uddi.client.doc:registeredInfo
pub.uddi.client.doc:relatedBusinessInfo
pub.uddi.client.doc:relatedBusinessInfos
pub.uddi.client.doc:relatedBusinessesList pub.uddi.client.doc:result pub.uddi.client.doc:schema_uddiv2
pub.uddi.client.doc:serviceDetail
pub.uddi.client.doc:serviceInfo
570
33 UDDI Folder
Element pub.uddi.client.doc:serviceInfos pub.uddi.client.doc:serviceKey pub.uddi.client.doc:serviceList pub.uddi.client.doc:sharedRelationships pub.uddi.client.doc:SOAPFault pub.uddi.client.doc:tModel
Package and Description WmUDDI.Documenttypethatconsists oflistofserviceInfodocuments. WmUDDI.DocumenttypethatisaUUID keytoidentifyaservice. WmUDDI.Documenttypethatcontains listofserviceInfodocuments. WmUDDI.Documenttypethatcontains thekeyedreferencesanddirectiontoit. WmUDDI.Documenttypethatcontains theSOAPFaultstructure. WmUDDI.Documenttypethattakesthe formofkeyedmetadata(dataaboutdata). Inageneralsense,thepurposeofatModel withintheUDDIregistryistoprovidea referencesystembasedonabstraction. WmUDDI.Documenttypethatcontainsa listoftModelKeys. WmUDDI.Documenttypethatcontains listoftModeldocuments. WmUDDI.Documenttypethatcontains overviewdataaboutbusinessandtModel informationpublishedbyagiven publisher. WmUDDI.Documenttypethatconsists oflistoftModelInfodocuments. WmUDDI.Documenttypethatisa simpleaccessorcontainerforoneormore pub.uddi.client.doc:tModelInstanceInfo documents. WmUDDI.Documenttypethatisa tModelInstanceInfostructure representingthebindingTemplate instancespecificdetailsforasingle tModelbyreference. WmUDDI.Documenttypethatcontainsa tModelKeyUUID. WmUDDI.Documenttypethatcontains zeroormoretModelInfostructuresin responsetoafind_tModelinquiry message.
pub.uddi.client.doc:tModelBag pub.uddi.client.doc:tModelDetail pub.uddi.client.doc:tModelInfo
pub.uddi.client.doc:tModelInfos pub.uddi.client.doc:tModelInstanceDetails
pub.uddi.client.doc:tModelInstanceInfo
pub.uddi.client.doc:tModelKey pub.uddi.client.doc:tModelList
571
33 UDDI Folder
Element pub.uddi.client.doc:toKey pub.uddi.client.doc:uploadRegister pub.uddi.client.inquiry:find_binding pub.uddi.client.inquiry:find_business
Package and Description WmUDDI.Documenttypethatcontains thetoKeyUUID. WmUDDI.Documenttypethatcontains theuploadRegisterstring. WmUDDI.Locatesspecificbindings withinaregisteredbusinessservice. WmUDDI.Locatesoneormore businesses.ItthenreturnsabusinessList messagethatmatchestheconditions specifiedintheargument. WmUDDI.Locatesoneormore businessesbasedoncategoryreferences passed. WmUDDI.Locatesoneormore businessesbasedondiscoveryURLs. WmUDDI.Locatesoneormore businessesbasedonbusinessidentifier references. WmUDDI.Locatesoneormore businessesbasedonnames. WmUDDI.Locatesoneormore businessesbasedontModelreferences. WmUDDI.Locatesinformationabout pub.uddi.client.doc:businessEntityregistrations thatarerelatedtothespecificbusiness entitywhosekeyispassedintheinquiry. WmUDDI.Locatesspecificservices withinaregistered pub.uddi.client.doc:businessEntity. WmUDDI.Locatesspecificservices withinaregistered pub.uddi.client.doc:businessEntitybasedon businesskeyidentifier. WmUDDI.Locatesspecificservices withinaregistered pub.uddi.client.doc:businessEntitybasedonlist ofcategorykeyidentifiers.
pub.uddi.client.inquiry:find_businessByCategory
pub.uddi.client.inquiry:find_businessByDiscURLs pub.uddi.client.inquiry:find_businessByIdentity
pub.uddi.client.inquiry:find_businessByName pub.uddi.client.inquiry:find_businessBytModel pub.uddi.client.inquiry:find_relatedBusinesses
pub.uddi.client.inquiry:find_service
pub.uddi.client.inquiry:find_serviceByBusKey
pub.uddi.client.inquiry:find_serviceByCategory
572
33 UDDI Folder
Element pub.uddi.client.inquiry:find_serviceByName
Package and Description WmUDDI.Locatesspecificservices withinaregistered pub.uddi.client.doc:businessEntitybasedonlist ofservicenames. WmUDDI.Locatesspecificservices withinaregistered pub.uddi.client.doc:businessEntitybasedonlist oftModelreferences. WmUDDI.LocatesoneormoretModel informationstructuresmatchingthesetof specificcriteria. WmUDDI.LocatesoneormoretModel informationstructuresbasedonlistof categoryreferences. WmUDDI.LocatesoneormoretModel informationstructuresbasedonlistof businessidentityreferences. WmUDDI.LocatesoneormoretModel informationstructuresbasedonlistof businessidentityreferences. WmUDDI.Retrievesfullbinding templateinformationsuitableformaking oneormoreservicerequests. WmUDDI.Retrievesthefull pub.uddi.client.doc:businessEntityinformation foroneormorebusinessesor organizations. WmUDDI.Retrievesextended pub.uddi.client.doc:businessEntityinformation foroneormorespecified pub.uddi.client.doc:businessEntityregistrations. WmUDDI.Retrievesfulldetailsfora givensetofregisteredbusinessService data. WmUDDI.Retrievesfulldetailsfora givensetofregisteredtModeldata. WmUDDI.Addsrelationshipassertions totheexistingsetofassertions.
pub.uddi.client.inquiry:find_serviceBytModel
pub.uddi.client.inquiry:find_tModel
pub.uddi.client.inquiry:find_tModelByCategory
pub.uddi.client.inquiry:find_tModelByIdentity
pub.uddi.client.inquiry:find_tModelByName
pub.uddi.client.inquiry:get_bindingDetail
pub.uddi.client.inquiry:get_businessDetail
pub.uddi.client.inquiry:get_businessDetailExt
pub.uddi.client.inquiry:get_serviceDetail
pub.uddi.client.inquiry:get_tModelDetail pub.uddi.client.publish:add_publisherAssertions
573
33 UDDI Folder
Element pub.uddi.client.publish:delete_binding
Package and Description WmUDDI.Deletesoneormoreinstances ofbindingTemplatedatafromtheUDDI registry. WmUDDI.Removesoneormore businessregistrations(forexample, registeredpub.uddi.client.doc:businessEntity data)andalldirectcontentsfromaUDDI registry. WmUDDI.Removesoneormore publisherAssertionelementstobe removedfromapublishersassertion collection. WmUDDI.Removesoneormore previouslybusinessServiceelementsfrom theUDDIregistryandfromitscontaining pub.uddi.client.doc:businessEntityparent. WmUDDI.Logicallydeletesoneormore tModelstructures.Logicaldeletionhides thedeletedtModelsfromfind_tModel resultsets,butdoesnotphysicallydelete it. WmUDDI.InformsanOperatorSitethat theauthenticationtokenistobe discarded,effectivelyendingthesession. WmUDDI.Providesadministrative supportfordeterminingthestatusof currentandoutstandingpublisher assertionsthatinvolveanyofthebusiness registrationsmanagedbytheindividual publisheraccount. WmUDDI.Obtainsanauthentication token. WmUDDI.Obtainsthefullsetof publisherassertionsthatisassociated withanindividualpublisheraccount. WmUDDI.Getsanabbreviatedlistofall pub.uddi.client.doc:businessEntityandtModel datathatarecontrolledbytheindividual associatedwiththecredentialspassed. WmUDDI.Savesorupdatesacomplete bindingTemplateelement.
pub.uddi.client.publish:delete_business
pub.uddi.client.publish:delete_publisherAssertions
pub.uddi.client.publish:delete_service
pub.uddi.client.publish:delete_tModel
pub.uddi.client.publish:discard_authToken
pub.uddi.client.publish:get_assertionstatusReport
pub.uddi.client.publish:get_authToken pub.uddi.client.publish:get_publisherAssertions
pub.uddi.client.publish:get_registeredInfo
pub.uddi.client.publish:save_binding
574
33 UDDI Folder
Element pub.uddi.client.publish:save_business
Package and Description WmUDDI.Savesorupdatesinformation aboutacomplete pub.uddi.client.doc:businessEntityelement. WmUDDI.Addsorupdatesoneormore businessServiceelements. WmUDDI.Addsorupdatesoneormore registeredtModelelements. WmUDDI.Managesallofthetracked relationshipassertionsassociatedwithan individualpublisheraccount.
pub.uddi.client.publish:save_service pub.uddi.client.publish:save_tModel pub.uddi.client.publish:set_publisherAssertions
pub.uddi.client.doc:accessPoint
WmUDDI.Documenttypethatconveystheentrypointaddresssuitableforcallinga particularWebservice. The accessPointdocumenttypeisanattributequalifiedpointertoa serviceentrypoint. Parameters *body @URLType StringOptional.BodyoftheURL. StringTypeofURL. A value of...
mailto
Indicates that... Theentryservicepointisformattedasanelectronicmail addressreference,forexample,mailto:purch@fabrikam.com. TheentryservicepointisformattedasanHTTPcompatible URL,forexample,http://www.fabrikam.com/purchasing. TheentryservicepointisformattedasasecureHTTP compatibleURL,forexample, https://www.fabrikam.com/purchasing. TheentryservicepointisformattedasaFTPdirectory address,forexample,ftp://ftp.fabrikam.com/public. Theentryservicepointisformattedasatelephonenumber thatwillconnecttoafacsimilemachine,forexample,1 425 555 5555.
http
https
ftp
fax
575
33 UDDI Folder
phone
Theentryservicepointisformattedasatelephonenumber thatwillconnecttovoiceortoneresponsebasedsystem,for example, 1 425 555 5555. Theentryservicepointisformattedassomeotheraddress format.Whenthisvalueisused,oneormoreofthe pub.uddi.client.doc:tModelsignaturesfoundinthe pub.uddi.client.doc:tModelInstanceInfocollectionmustspecifythat aparticularformatortransporttypeisrequired.
other
See Also pub.uddi.client.doc:tModel pub.uddi.client.doc:tModelInstanceInfo Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:create_bindingTemplate
pub.uddi.client.doc:address
WmUDDI.Documenttypethatisasimplelistofpub.uddi.client.doc:addressLineelements withintheaddresscontainer. Parameters @useType @sortCode String Optional.Descriptionofthetypeofaddress,forexample, billingdepartment,ormainoffice. String Optional.Usedtodrivethebehaviorofexternaldisplay mechanismsthatsortaddresses. A value of...
numeric alphabetic first n
Indicates... Numericordering(forexample,1,2,3). Alphabeticordering(forexample,a,b,c). Orderingofthefirstnpositionsofdatainthe address.
@tModelKey
String Optional.UniquekeyreferencethatimpliesthatthekeyName keyValuepairsgivenbysubsequentpub.uddi.client.doc:addressLine elementsaretobeinterpretedbythetaxonomyassociatedwiththe pub.uddi.client.doc:tModelthatisreferenced. Document type List Optional.Listofpub.uddi.client.doc:addressLine documents.
addressLine
576
33 UDDI Folder
See Also pub.uddi.client.doc:addressLine pub.uddi.client.doc:tModel
pub.uddi.client.doc:addressLine
WmUDDI.Documenttypethatcontainstheaddresslineinformation. addressLineelementscontainstringdatawithalinelengthlimitof80characterpositions. EachaddressLineelementcancontaintwooptionaldescriptiveattributes,keyNameand keyValue. Parameters *body @keyName @keyValue String Optional.Bodyoftheaddressline. String Optional.Keynameoftheaddressline. String Optional.Keyvalueoftheaddressline.
pub.uddi.client.doc:assertionStatusItem
WmUDDI.Documenttypethatcontainstheassertionstatusinformation. Italsoformsthepartofthepub.uddi.client.doc:assertionStatusReportdocument. Parameters @completionStatus StringAssertioncompletionstatus. Value
status:complete
Description Returnsonlythepublisher assertionsthatarecomplete. Returnsonlythosepublisher assertionswherethepartythat controlsthe pub.uddi.client.doc:businessEntity referencedbythetoKeyvaluehas notmadeamatchingassertion. Returnsonlythosepublisher assertionswherethepartythat controlsthe pub.uddi.client.doc:businessEntity referencedbythefromKeyvaluehas notmadeamatchingassertion.
status:toKey_incomplete
status:fromKey_incomplete
577
33 UDDI Folder
tromKey toKey keyedReference keysOwned See Also
String Uniquekeyreferencetothefirst pub.uddi.client.doc:businessEntityforwhichtheassertionismade. String Uniquekeyreferencetothesecond pub.uddi.client.doc:businessEntityforwhichtheassertionismade. Document type Therelationshiptypeforwhichtheassertionis made. Document type Listofthepub.uddi.client.doc:businessKeyelementsthe publishermanages.
pub.uddi.client.doc:assertionStatusReport pub.uddi.client.doc:businessEntity pub.uddi.client.doc:businessKey
pub.uddi.client.doc:assertionStatusReport
WmUDDI.Documenttypethatreportsallcompleteandincompleteassertionsand servesanadministrativeuse,includingdeterminingifthereareanyoutstanding, incompleteassertionsaboutrelationshipsinvolvingbusinesseswithwhichthepublisher accountisassociated. Parameters @generic @operator assertionStatusItem String Generalinformation,suchasversion. StringUDDIoperatorinformation. Document type Optional.Assertionstatusinformation. A value of...
status:complete
Indicates... Returnsonlythepublisher assertionsthatarecomplete.
578
33 UDDI Folder
Returnsonlythosepublisher assertionswherethepartythat controlsthe pub.uddi.client.doc:businessEntity referencedbythetoKeyvalue hasnotmadeamatching assertion. Returnsonlythosepublisher assertionswherethepartythat controlsthe pub.uddi.client.doc:businessEntity referencedbythefromKeyvalue hasnotmadeamatching assertion.
pub.uddi.client.doc:authToken
WmUDDI.DocumenttypethatcontainsasingleauthInfoelementthatcontainsanaccess tokenthatistobepassedbackinallPublishersAPImessagesthatchangedata. Parameters @generic @operator authInfo Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:deleteMyBusiness samples.uddi.client:publishMyBinding samples.uddi.client:publishMyBusiness samples.uddi.client:publishMyService String Generalinformation,suchasversion. StringUDDIoperatorinformation. String AnaccesstokenthatistobepassedbackinallPublishers APImessagesthatchangedata.
579
33 UDDI Folder
pub.uddi.client.doc:bindingDetail
WmUDDI.DocumenttypethatconsistsofoneormorebindingTemplatestructuresthat arereturnedaccordingtothedatarequestedintherequestmessage. Parameters @generic @operator @truncated String Generalinformation,suchasversion. StringUDDIoperatorinformation. String Aflagthatindicateswhetherornottotruncatethereturned messages. A value of...
true
Indicates that... Theresultsaretruncatedtothevaluespecifiedin maxrows. Theresultsarenottruncated.
false
bindingTemplate Examples
Document type Optional.Technicalservicedescriptioninformation relatedtoagivenbusinessservicefamily.
SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:publishMyBinding
pub.uddi.client.doc:bindingKey
WmUDDI.DocumenttypethatcontainsauniquekeyforagivenbindingTemplate. Parameters bindingKey String UniquekeyforagivenbindingTemplate.
pub.uddi.client.doc:bindingTemplate
WmUDDI.Documenttypethatholdstechnicalservicedescriptioninformationrelatedto agivenbusinessservicefamily. Parameters @serviceKey @bindingKey String Optional.Uniquekeyforagivenservice. StringUniquekeyforagivenbindingTemplate.
580
33 UDDI Folder
description
Document type Optionalrepeatingelement.Zeroormore languagequalifiedtextdescriptionsofthetechnicalservice entrypoint. Document type Textfieldthatisusedtoconveytheentrypoint addresssuitableforcallingaparticularWebservice. Document type RequiredelementifaccessPointnotprovided. ThiselementhasabindingKeyattribute,givingtheredirected referencetoadifferentbindingTemplate. Document type ListofzeroormoretModelInstanceInfo elements.Thisdata,takenintotal,shouldformadistinct fingerprintthatcanbeusedtoidentifycompatibleservices.
accessPoint hostingRedirector
tModelInstanceDetails
Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:create_bindingTemplate
pub.uddi.client.doc:bindingTemplates
WmUDDI.DocumenttypethatcontainslistofbindingTemplates. Parameters bindingTemplate Document type List Technicalservicedescriptioninformationrelated toagivenbusinessservicefamily.
pub.uddi.client.doc:businessDetail
WmUDDI.DocumenttypethatconsistsofoneormorebusinessDetailstructuresthatare returnedaccordingtothedatarequestedintherequestmessage. Parameters @generic @operator @truncated String Generalinformation,suchasversion. StringUDDIoperatorinformation. String Aflagthatindicateswhetherornottotruncatethereturned messages. A value of...
true
false
581
33 UDDI Folder
businessEntity Examples
Document type List Listofpub.uddi.client.doc:businessEntitydocuments.
SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:publishMyBusiness
pub.uddi.client.doc:businessDetailExt
WmUDDI.DocumenttypethatconsistsofoneormorebusinessDetailExtstructuresthat arereturnedaccordingtothedatarequestedintherequestmessage. Parameters @generic @operator @truncated String Generalinformation,suchasversion. StringUDDIoperatorinformation. String Aflagthatindicateswhetherornottotruncatethereturned messages. A value of...
true
false
BusinessEntityExt
Document type List ListofbusinessEntityExtstructures.
pub.uddi.client.doc:businessEntity
WmUDDI.Documenttypethatrepresentsallknowninformationaboutabusinessor entitythatpublishesdescriptiveinformationabouttheentityaswellastheservicesthatit offers. Parameters @businessKey @operator @authorizedName discoveryURLs name description String AuniqueUUIDidentifierforaspecificinstanceof businessEntity. StringUDDIoperatorinformation. StringRecordednameoftheindividualthatpublishedthe businessEntitydata. Document type AdiscoverURLsdocument. Document type Listofnamedocuments. Document type Listofdescriptiondocuments.
582
33 UDDI Folder
contacts businessServices identifierBag categoryBag Examples
Document type Acontactsdocument. Document type AbusinessServicesdocument. Document type AnidentiferBagdocument. Document type AcategoryBagdocument.
SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:create_businessEntity
pub.uddi.client.doc:businessEntityExt
WmUDDI.Documenttypethatcontainsapub.uddi.client.doc:businessEntitydocument. Parameters businessEntity Document type Apub.uddi.client.doc:businessEntitydocument.
pub.uddi.client.doc:businessInfo
WmUDDI.Documenttypethatcontainscompanynameandoptionaldescriptiondata, alongwithacollectionelementnamedserviceInfosthatinturncancontainoneormore serviceInfostructures. Parameters @businessKey name description serviceInfos String AuniqueUUIDidentifierforaspecificinstanceof pub.uddi.client.doc:businessEntity. Document type List Listofnamedocuments. Document type List Listofdescriptiondocuments. Document type List AserviceInfosdocument.
pub.uddi.client.doc:businessInfos
WmUDDI.DocumenttypethatconsistsoflistofbusinessInfodocuments. Parameters businessInfo Document type List ListofbusinessInfodocuments.
583
33 UDDI Folder
pub.uddi.client.doc:businessKey
WmUDDI.Documenttypethatcontainstheuniqueidentifierforagiveninstanceofa pub.uddi.client.doc:businessEntitystructure. Parameters @businessKey String AuniqueUUIDidentifierforaspecificinstanceof pub.uddi.client.doc:businessEntity.
pub.uddi.client.doc:businessList
WmUDDI.DocumenttypethatcontainszeroormorebusinessInfosstructures. Parameters @generic @operator @truncated String Generalinformation,suchasversion. StringUDDIoperatorinformation. String Aflagthatindicateswhetherornottotruncatethereturned messages. A value of...
true
false
businessInfos
Document type list ListofbusinessInfosdocuments
pub.uddi.client.doc:businessService
WmUDDI.Documenttypethatrepresentsalogicalserviceclassification. Thenameoftheelementincludesthetermbusinessinanattempttodescribethe purposeofthislevelintheservicedescriptionhierarchy. Parameters @businessKey @serviceKey name description String Uniqueidentifierforagiveninstanceofa pub.uddi.client.doc:businessEntitystructure. String Uniquekeyforagivenservice. Document type List Listofnamedocuments. Document type List Listofdescriptiondocuments.
584
33 UDDI Folder
BindingTemplates categoryBag Examples
Document type List AbindingTemplatesdocument. Document type AcategoryBagdocument.
SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:create_businessService
pub.uddi.client.doc:businessServices
WmUDDI.DocumenttypethatliststhebusinessServicedocuments. Parameters businessService Document reference List ListofbusinessServicedocument.
pub.uddi.client.doc:categoryBag
WmUDDI.Documenttypethatallowspub.uddi.client.doc:businessEntity,businessService,and tModelstructurestobecategorizedaccordingtoanyofseveralavailabletaxonomybased classificationschemes. OperatorSitesautomaticallyprovidevalidatedcategorizationsupportforthree taxonomiesthatcoverindustrycodes(viaNAICS),productandserviceclassifications (viaUNSPC)andgeography(viaISO3166). Parameters keyedReference Document reference List ListofkeyedReferencedocuments.
pub.uddi.client.doc:contact
WmUDDI.Documenttypethatletsyourecordcontactinformationforaperson. Thisinformationcanconsistofoneormoreoptionalelements,alongwithapersons name.Contactinformationexistsbycontainmentrelationshipalone,andnomechanisms fortrackingindividualcontactinstancesisprovidedbyUDDIspecifications. Parameters @useType description personName String Optional.Descriptionofthetypeofcontactinfreeformtext, forexample,salescontact,ortechnicalservicescontact. Document type List Listofdescriptiondocuments. String Nameofthepersonornameofthejobrole.
585
33 UDDI Folder
phone email address Examples
Document type List Telephonenumbersforthecontact.Listofphone documents. Document type List Emailaddressesforthecontact.Listofemail documents. Document type List Printablelinessuitableforaddressingan envelope.Listofemaildocuments.
SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:create_businessEntity
pub.uddi.client.doc:contacts
WmUDDI.Documenttypethatprovidesawayforinformationtoberegisteredwitha pub.uddi.client.doc:businessEntityrecordsothatsomeonethatfindstheinformationcanmake humancontactforanypurpose. Parameters contact Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:create_businessEntity Document type List Listofcontactdocuments.
pub.uddi.client.doc:discoveryURL
WmUDDI.DocumenttypethatconsistsofanattributewhosevaluedesignatestheURL usetypeconvention,andastring,foundwithinthebodyoftheelement. Eachtimeapub.uddi.client.doc:businessEntitystructureissavedviaacalltosave_business,the UDDIOperatorSitewillgenerateoneURL.ThegeneratedURLwillpointtoaninstance ofeitherapub.uddi.client.doc:businessEntityorbusinessEntityExtstructure,andtheuseType attributeofthediscoveryURLwillbesettoeitherbusinessEntityorbusinessEntityExt accordingtothedatatypefoundwhileprocessingthesave_businessmessage. Parameters *body @useType StringBodyoftheURL. String Nameoftheconventionthatthereferenceddocument follows.
586
33 UDDI Folder
Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:create_businessEntity
pub.uddi.client.doc:discoveryURLs
WmUDDI.DocumenttypethatisusedtoholdpointerstoURLaddressablediscovery documents. Parameters discoveryURL Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:create_businessEntity Document type List ListofdiscoveryURLdocuments.
pub.uddi.client.doc:dispositionReport
WmUDDI.Documenttypethatisusedtoreportstatusofvariouspublishoperations. Parameters @generic @operator @truncated String Generalinformation,suchasversion. StringUDDIoperatorinformation. String Aflagthatindicateswhetherornottotruncatethereturned messages. A value of... true false Result Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:deleteMyBusiness Indicates that... Theresultsaretruncatedtothevaluespecifiedin maxrows. Theresultsarenottruncated.
Document type list Listofresultdocuments.
587
33 UDDI Folder
pub.uddi.client.doc:docType_categoryBag
WmUDDI.Documenttypethatallowspub.uddi.client.doc:businessEntity,businessServiceand tModelstructurestobecategorizedaccordingtoanyofseveralavailabletaxonomybased classificationschemes. OperatorSitesautomaticallyprovidevalidatedcategorizationsupportforthree taxonomiesthatcoverindustrycodes(viaNAICS),productandserviceclassifications (viaUNSPC)andgeography(viaISO3166). Parameters keyedReference Document reference List ListofkeyedReferencedocuments.
pub.uddi.client.doc:docType_description
WmUDDI.Documenttypethatcontainsthedescriptionwithlanguageresource information. Parameters *body @xml:lang String Bodyofthedescription. String Languagetypeofthedescription.
pub.uddi.client.doc:docType_keyedReference
WmUDDI.Documenttypethatdesignatestherelationshiptypeforwhichtheassertionis made,representedbytheincludedtModelKeyanddescribedbytheincludedkeyName keyValuepair. Parameters @tModelKey @keyName @keyValue String UniquekeyreferencetotModel. String Keyname. String Keyvalue.
588
33 UDDI Folder
pub.uddi.client.doc:docType_name
WmUDDI.Documenttypethatdescribesaname. Parameters *body @xml:lang String Name. String Languagetypeofthedescription.
pub.uddi.client.doc:email
WmUDDI.Documenttypethatdescribestheemailinformation. Parameters *body @useType String Emailinformation. String Descriptionoftheemailinformation.
pub.uddi.client.doc:errInfo
WmUDDI.Documenttypethatdescribestheerrorinformation. Parameters *body @errCode String Errorstring. String Errorcode.
pub.uddi.client.doc:findQualifier
WmUDDI.Documenttypethatprovidesameanstoallowthecallertooverridedefault searchbehaviors. Parameters findQualifier StringQualifierfromalistofqualifiers.
589
33 UDDI Folder
pub.uddi.client.doc:findQualifiers
WmUDDI.Documenttypethatcontainsalistoffindqualifiers. Parameters findQualifier String List Listoffindqualifiers.
pub.uddi.client.doc:fromKey
WmUDDI.DocumenttypethatcontainsaUUIDreferencetoabusinessEntity. Parameters fromKey String AUUIDreferencetoabusinessEntity.
pub.uddi.client.doc:hostingRedirector
WmUDDI.DocumenttypethatisusedtodesignatethatabindingTemplateentryisa pointertoadifferentbindingTemplateentry. Parameters @bindingKey StringBindingkey.
pub.uddi.client.doc:identifierBag
WmUDDI.Documenttypethatisageneralpurposeplaceholderforanynumberof distinctidentifiers. Parameters keyedReference Document reference List ListofkeyedReferencedocuments.
590
33 UDDI Folder
pub.uddi.client.doc:instanceDetails
WmUDDI.Documenttypethatholdsserviceinstancespecificinformationthatis requiredtoeitherunderstandtheserviceimplementationdetailsrelativetoaspecific tModelKeyreference,ortoprovidefurtherparameterandsettingssupport. Parameters description Document reference List Languagequalifiedtextelementthat describesofthepurposeand/oruseoftheparticular instanceDetailsentry.Listofdoctype_descriptiondocuments. Document type Referencestoremotedescriptiveinformationor instructionsrelatedtoproperuseofabindingTemplatetechnical subelement.ContainsaoverviewDocdocument. String SettingsparametersoraURLreferencetoafilethatcontains settingsorparametersrequiredtouseaspecificfacetofa bindingTemplatedescription.
overviewDoc
instanceParms
pub.uddi.client.doc:instanceParms
WmUDDI.DocumenttypethatisusedtocontainsettingsparametersoraURLreference toafilethatcontainssettingsorparametersrequiredtouseaspecificfacetofa bindingTemplatedescription. Parameters instanceParms String SettingparametersorURLreferencetoafilethatcontains thesesettings.
pub.uddi.client.doc:keyedReference
WmUDDI.Documenttypethatdesignatestherelationshiptypeforwhichtheassertionis made,representedbytheincludedtModelKeyanddescribedbytheincludedkeyName keyValuepair. Parameters @tModelKey @keyName @keyValue String UniquekeyreferencetotModel. String Keyname. String Keyvalue.
591
33 UDDI Folder
pub.uddi.client.doc:keysOwned
WmUDDI.Documenttypethatdesignatesthosebusinesskeysthepublishermanages. Parameters FromKey toKey String Uniquekeyreferencetothefirstpub.uddi.client.doc:businessEntity forwhichtheassertionismade. String Uniquekeyreferencetothesecond pub.uddi.client.doc:businessEntityforwhichtheassertionismade.
pub.uddi.client.doc:overviewDoc
WmUDDI.Documenttypethatisusedtohousereferencestoremotedescriptive informationorinstructionsrelatedtoproperuseofabindingTemplatetechnicalsub element. Parameters description overviewURL Document type Languagequalifiedstringcontainingashort descriptiveoverviewofhowaparticulartModelistobeused. String URLreferencetoalongformofanoverviewdocumentthat coversthewayaparticulartModelspecificreferenceisusedasa componentofanoverallwebservicedescription.
pub.uddi.client.doc:phone
WmUDDI.Documenttypethatisusedtoholdtelephonenumbersforthecontact. ThiselementcancontainanoptionaluseTypeattributefordescriptivepurposes. Parameters *body @useType Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:create_businessEntity String Telephonenumber. String Moredescriptionofbody.
592
33 UDDI Folder
pub.uddi.client.doc:publisherAssertion
WmUDDI.Documenttypethatdescribesapublisherassertionstructure. Parameters FromKey toKey KeyedReference String Uniquekeyreferencetothefirstpub.uddi.client.doc:businessEntity forwhichtheassertionismade. String Uniquekeyreferencetothesecond pub.uddi.client.doc:businessEntityforwhichtheassertionismade Document type Relationshiptypeforwhichtheassertionismade.
pub.uddi.client.doc:publisherAssertions
WmUDDI.Documenttypethatreturnsallassertionsmadebythepublisherwhowas authenticatedintheprecedingset_publisherAssertionsortheget_publisherAssertions APIcalls. Parameters @generic @operator @authorizedName publisherAssertion String Generalinformation,suchasversion. StringUDDIoperatorinformation. String Recordednameoftheindividualthatpublishedthe pub.uddi.client.doc:businessEntitydata. Document type ListofPublisherAssertiondocument.
pub.uddi.client.doc:registeredInfo
WmUDDI.Documenttypethatcontainsoverviewinformationthatissuitablefor identifyingallpub.uddi.client.doc:businessEntityandtModeldatapublishedbytherequester. Parameters @generic @operator String Generalinformation,suchasversion. StringUDDIoperatorinformation.
593
33 UDDI Folder
@truncated
String Aflagthatindicateswhetherornottotruncatethereturned messages. A value of...

true
Indicates that... Theresultsaretruncatedtothevaluespecified inmaxrows. Theresultsarenottruncated.
false
businessInfos tModelInfos
Document type AbusinessInfosdocument. Document type AtModelInfosdocument.
pub.uddi.client.doc:relatedBusinessInfo
WmUDDI.Documenttypethatcontainsinformationaboutapub.uddi.client.doc:businessEntity thatrelatestothespecifiedpub.uddi.client.doc:businessEntitybyatleastonerelationship. Parameters @businessKey name description sharedRelationships String Uniqueidentifierforagiveninstanceofa pub.uddi.client.doc:businessEntitystructure. Document type List Listofnamedocuments. Document type List Listofdescriptiondocuments. Document type AsharedRelationshipsdocument.
pub.uddi.client.doc:relatedBusinessInfos
WmUDDI.Documenttypethatcontainsinformationaboutapub.uddi.client.doc:businessEntity thatrelatestothespecifiedpub.uddi.client.doc:businessEntitybyatleastonerelationship. Parameters @businessKey name description sharedRelationships String Uniqueidentifierforagiveninstanceofa pub.uddi.client.doc:businessEntitystructure. Document type List Listofnamedocuments. Document type List Listofdescriptiondocuments. Document type AsharedRelationshipsdocument.
594
33 UDDI Folder
pub.uddi.client.doc:relatedBusinessesList
WmUDDI.Documenttypethatcontainslistofrelatedbusinesslists. Parameters @generic @operator @truncated String Generalinformation,suchasversion. StringUDDIoperatorinformation. String Aflagthatindicateswhetherornottotruncatethe returnedmessages. A value of... true false @businessKey relatedbusinessInfos Indicates that... Theresultsaretruncatedtothevaluespecifiedin maxrows. Theresultsarenottruncated.
String Uniqueidentifierforagiveninstanceofa pub.uddi.client.doc:businessEntitystructure. Document type ListofrelatedbusinessInfosdocuments.
pub.uddi.client.doc:result
WmUDDI.Documenttypethatdefinestheresultstructure. Parameters @keyType @errno errInfo String Keytype. String Theerroridentifier Document type TheerrInfodocument.
595
33 UDDI Folder
pub.uddi.client.doc:schema_uddiv2
WmUDDI.SchemacreatedusingthewebMethodsschemageneratoraspartofcreating documenttypes.ItiscreatedfromtheXSDdocumentspecifiedbyUDDIVersion2.0 UDDIXMLSchema2001.
pub.uddi.client.doc:serviceDetail
WmUDDI.Documenttypethatcontainscompletedescriptiveandtechnicaldetailsabout registeredservices. Parameters @generic @operator @truncated String Generalinformation,suchasversion. String UDDIoperatorinformation. String Aflagthatindicateswhetherornottotruncatethereturned messages. A value of...
true
false
businessService Examples
Document type ListofbusinessServicedocuments.
SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:findAllServicesOfBusiness samples.uddi.client:publishMyService
pub.uddi.client.doc:serviceInfo
WmUDDI.DocumenttypethatareabbreviatedversionsofbusinessServicedata, suitableforpopulatingalistofservicesassociatedwithabusinessandthatmatcha patternasspecifiedintheinputstothefind_serviceAPI. Parameters @serviceKey businessKey name String Uniquekeyforagivenservice. String Uniqueidentifierforagiveninstanceofa pub.uddi.client.doc:businessEntitystructure. Document type List Listofnamedocuments.
596
33 UDDI Folder
pub.uddi.client.doc:serviceInfos
WmUDDI.DocumenttypethatconsistsoflistofserviceInfodocuments. Parameters serviceInfo Document type List ListofserviceInfodocuments.
pub.uddi.client.doc:serviceKey
WmUDDI.DocumenttypethatisaUUIDkeytoidentifyaservice. Parameters @serviceKey StringUniquekeyforagivenservice.
pub.uddi.client.doc:serviceList
WmUDDI.DocumenttypethatcontainslistofserviceInfodocuments. Parameters @generic @operator @truncated String Generalinformation,suchasversion. String UDDIoperatorinformation. String Aflagthatindicateswhetherornottotruncatethereturned messages. A value of...
true
false
serviceInfo
Document type List ListofserviceInfodocuments.
pub.uddi.client.doc:sharedRelationships
WmUDDI.Documenttypethatcontainsthekeyedreferencesanddirectiontoit. Parameters @direction keyedReference StringDirectiontokeyedReferencedocument. Document reference List ListofkeyedReferencedocuments.
597
33 UDDI Folder
pub.uddi.client.doc:SOAPFault
WmUDDI.DocumenttypethatcontainstheSOAPFaultstructure. Parameters faultcode faultstring faultactor detail String Optional.SOAPFaultcode. String Optional.SOAPFaultstring. String Optional.SOAPFaultactor. Document type Optional.Detailsofthefault.Thedetailstructure containsthepub.uddi.client.doc:dispositionReportdocument.
pub.uddi.client.doc:tModel
WmUDDI.Documenttypethattakestheformofkeyedmetadata(dataaboutdata).Ina generalsense,thepurposeofatModelwithintheUDDIregistryistoprovideareference systembasedonabstraction. TheinformationthatmakesupatModelisquitesimple.Theresakey,aname,anoptional description,andthenaURLthatpointstoalocationtogotofindoutmoreaboutthe actualconceptrepresentedbythemetadatainthetModelitself. Parameters tModelKey @operator @authorizedName Name description overviewDoc identifierBag categoryBag String UniquekeyforagiventModelstructure. String CertifiednameoftheUDDIregistrysiteoperatorthat managesthemastercopyofthetModeldata. String RecordednameoftheindividualthatpublishedthetModel data. Document type List NamerecordedforthetModel.Namesearchis providedviafind_tModelcall. Document type List Oneormoreshortlanguagequalified descriptions. Document type List Referencestoremotedescriptiveinformationor instructionsrelatedtothetModel. Document type List Optional. Listofnamevaluepairsthatcanbe usedtorecordidentificationnumbersforatModel. Document type List Optional.Listofnamevaluepairsthatareused totagatModelwithspecifictaxonomyinformation.
598
33 UDDI Folder
pub.uddi.client.doc:tModelBag
WmUDDI.DocumenttypethatcontainsalistoftModelKeys. Parameters tModelKey String List ListuniquekeyforagiventModelstructure.
pub.uddi.client.doc:tModelDetail
WmUDDI.DocumenttypethatcontainslistoftModeldocuments. Parameters @generic @operator @truncated String Generalinformation,suchasversion. String UDDIoperatorinformation. String Aflagthatindicateswhetherornottotruncatethereturned messages. A value of...
true
false
tModel
Document type List ListoftModeldocuments.Thestructureofthis documentisdefinedinpub.uddi.client.doc:tModel.
pub.uddi.client.doc:tModelInfo
WmUDDI.DocumenttypethatcontainsoverviewdataaboutbusinessandtModel informationpublishedbyagivenpublisher. Parameters tModelKey name Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:create_bindingTemplate String UniquekeyforagiventModelstructure.Thestructureof thisdocumentisdefinedinpub.uddi.client.doc:tModelKey. Document type List NamerecordedforthetModel.Namesearchis providedviafind_tModelcall.
599
33 UDDI Folder
pub.uddi.client.doc:tModelInfos
WmUDDI.DocumenttypethatconsistsoflistoftModelInfodocuments. Parameters tModelInfo Document type List ListoftModelInfodocuments.
pub.uddi.client.doc:tModelInstanceDetails
WmUDDI.Documenttypethatisasimpleaccessorcontainerforoneormore pub.uddi.client.doc:tModelInstanceInfodocuments. Parameters tModelInstanceInfo Document type List ListoftModelInstanceInfodocuments.
pub.uddi.client.doc:tModelInstanceInfo
WmUDDI.DocumenttypethatisatModelInstanceInfostructurerepresentingthe bindingTemplateinstancespecificdetailsforasingletModelbyreference. Parameters @tmodelKey description String UniquekeyforagiventModelstructure. Document type List Listofdescriptiondocuments.Thisisoneor morelanguagequalifiedtextdescriptionsthatdesignatewhatrole atModelreferenceplaysintheoverallservicedescription. Document type List AninstanceDetaildocument.Thiselementcanbe usedwhentModelreferencespecificsettingsorotherdescriptive informationarerequiredtoeitherdescribeatModelspecific componentofaservicedescriptionorsupportservicesthatrequire additionaltechnicaldatasupport(forexample,viasettingsor otherhandshakeoperations)
instanceDetails
Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:create_bindingTemplate
600
33 UDDI Folder
pub.uddi.client.doc:tModelKey
WmUDDI.DocumenttypethatcontainsatModelKeyUUID. Parameters @tmodelKey String UniquekeyforagiventModelstructure.
pub.uddi.client.doc:tModelList
WmUDDI.DocumenttypethatcontainszeroormoretModelInfostructuresinresponse toafind_tModelinquirymessage. Parameters @generic @operator @truncated String Generalinformation,suchasversion. String UDDIoperatorinformation. String Aflagthatindicateswhetherornottotruncatethereturned messages. A value of...
true
false
tModelInfos
Document type List ListoftModelInfodocuments.
pub.uddi.client.doc:toKey
WmUDDI.DocumenttypethatcontainsthetoKeyUUID. Parameters toKey String Uniquekeyreferencetothesecond pub.uddi.client.doc:businessEntityforwhichtheassertionismade
pub.uddi.client.doc:uploadRegister
WmUDDI.DocumenttypethatcontainstheuploadRegisterstring. Parameters uploadRegister String TheuploadRegisterkey.
601
33 UDDI Folder
pub.uddi.client.inquiry:find_binding
WmUDDI.Locatesspecificbindingswithinaregisteredbusinessservice. ItthenreturnsabindingDetailmessagecontainingzeroormorebindingTemplate structurematchingthecriteriaspecifiedintheargumentlist.Onlythebindingsspecified byserviceKeywillbesearched. Input Parameters inquiryURL serviceKey maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String AUUIDkeytospecifyaparticularinstanceofa businessServiceelement. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type ListoftModelUUIDkeysthatrepresentthe technicalfingerprintofabindingTemplate.
tModelBag Output Parameters rawXMLResponse document SOAPFault status
String RawXMLresponsefromtheUDDIserver. Document type ThereturnedbusinessDetailobjectthatcontainsthe bindingtemplateinformation. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
Indicates that... Theservicecompletedsuccessfully. TheserviceterminatedonaSOAPfaultfromthe UDDIserver. TheservicedidnotcompleteduetoanHTTP connectionerror,forexample,HTTP 404. Theservicedidnotcompleteduetoanothererror condition,forexample,ServiceException.
-1
602
33 UDDI Folder
pub.uddi.client.inquiry:find_business
WmUDDI.Locatesoneormorebusinesses.ItthenreturnsabusinessListmessagethat matchestheconditionsspecifiedintheargument. Input Parameters inquiryURL businessNameList maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String List Optional.Listofnamesofbusinesstosearch. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type Optional.ListoftModelUUIDkeysthatrepresent thetechnicalfingerprintofabindingTemplate. Document type Optional.Listofbusinessidentifierreferences. Document type Optional.Listalistofcategoryreferences. Document type Optional.ListofURLstobematchedagainstthe discoveryURLdataassociatedwithanyregistered pub.uddi.client.doc:businessEntityinformation.
tModelBag identifierBag categoryBag discoveryURLs
Output Parameters
-
rawXMLResponse document SOAPFault status
String RawXMLresponsefromtheUDDIserver. Document type ThereturnedbusinessListobjectthatcontainsthe business,andsummariesofthebusinessServices. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
603
33 UDDI Folder
pub.uddi.client.inquiry:find_businessByCategory
WmUDDI.Locatesoneormorebusinessesbasedoncategoryreferencespassed. Input Parameters inquiryURL Marrows findQualifiers String URLindicatingthepathoftheUDDIserver. String Optional.Alimittothenumberofresultsreturned. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type Alistofcategoryreferences.
categoryBag Output Parameters rawXMLResponse document SOAPFault status
String RawXMLresponsefromtheUDDIserver. Document type ThereturnedbusinessListobjectthatcontainsthe business,andsummariesofthebusinessServices. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
pub.uddi.client.inquiry:find_businessByDiscURLs
WmUDDI.LocatesoneormorebusinessesbasedondiscoveryURLs. Input Parameters inquiryURL maxRows String URLindicatingthepathoftheUDDIserver. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall.
604
33 UDDI Folder
findQualifiers
String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type Optional.ListofURLstobematchedagainstthe discoveryURLdataassociatedwithanyregistered pub.uddi.client.doc:businessEntityinformation.
discoveryURLs
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type The returnedbusinessDetailobjectthatcontainsthe bindingtemplateinformation. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
pub.uddi.client.inquiry:find_businessByIdentity
WmUDDI.Locatesoneormorebusinessesbasedonbusinessidentifierreferences. Input Parameters inquiryURL maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type Optional.Listofbusinessidentifierreferences.
identifierBag
605
33 UDDI Folder
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturnedbusinessListobjectthatcontainsthe business,andsummariesofthebusinessServices. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
pub.uddi.client.inquiry:find_businessByName
WmUDDI.Locatesoneormorebusinessesbasedonnames. Input Parameters inquiryURL maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. String List Optional.Listofnamesofbusinesstosearch.
businessNameList Output Parameters rawXMLResponse Document SOAPFault
String RawXMLresponsefromtheUDDIserver. Document type ThereturnedbusinessListobjectthatcontainsthe business,andsummariesofthebusinessServices. Document type SOAPFaultinformation.
606
33 UDDI Folder
status
String Statusofthisservice. A value of...

0 1
-1
Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:findAllServicesOfBusiness
pub.uddi.client.inquiry:find_businessBytModel
WmUDDI.LocatesoneormorebusinessesbasedontModelreferences. Input Parameters inquiryURL Marrows findQualifiers String URLindicatingthepathoftheUDDIserver. String Optional.Maximumnumberofresultsreturned. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type ListoftModelUUIDkeysthatrepresentthe technicalfingerprintofabindingTemplate.
tModelBag Output Parameters rawXMLResponse Document SOAPFault
String RawXMLresponsefromtheUDDIserver. Document type The returnedbusinessListobjectthatcontainsthe business,andsummariesofthebusinessServices. Document type SOAPFaultinformation.
607
33 UDDI Folder
status

0 1
-1
pub.uddi.client.inquiry:find_relatedBusinesses
WmUDDI.Locatesinformationaboutpub.uddi.client.doc:businessEntityregistrationsthatare relatedtothespecificbusinessentitywhosekeyispassedintheinquiry. TheservicereturnsarelatedBusinessListdocumenttype. Input Parameters inquiryURL businessKey maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String Uniqueidentifierforagiveninstanceofa pub.uddi.client.doc:businessEntitystructure. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type Optional.Usedtospecifythatonlybusinessesthat relatedtothefocalpointinaspecificwayshouldbeincludedin theresults.
keyedReference
Output Parameters rawXMLResponse Document SOAPFault String RawXMLresponsefromtheUDDIserver. Document type The returnedrelatedBusinessListobject. Document type SOAPFaultinformation.
608
33 UDDI Folder
status

0 1
-1
pub.uddi.client.inquiry:find_service
WmUDDI.Locatesspecificserviceswithinaregisteredpub.uddi.client.doc:businessEntity. TheservicereturnsaserviceListmessagethatmatchestheconditionsspecifiedinthe arguments. Input Parameters inquiryURL businessKey maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String Uniqueidentifierforagiveninstanceofa pub.uddi.client.doc:businessEntitystructure. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type ListoftModelUUIDkeysthatrepresentthe technicalfingerprintofabindingTemplatetofind. Document type Listofcategoryreferences. String List Optional.Listofnamesofservicestobesearched.
tModelBag categoryBag ServiceNameList Output Parameters rawXMLResponse Document SOAPFault
String RawXMLresponsefromtheUDDIserver. Document type The returnedserviceListobject. Document type SOAPFaultinformation.
609
33 UDDI Folder
status

0 1
-1
pub.uddi.client.inquiry:find_serviceByBusKey
WmUDDI.Locatesspecificserviceswithinaregisteredpub.uddi.client.doc:businessEntity basedonbusinesskeyidentifier. TheservicereturnsaserviceListmessagethatmatchestheconditionsspecifiedinthe arguments. Input Parameters inquiryURL businessKey maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String Uniqueidentifierforagiveninstanceofa pub.uddi.client.doc:businessEntitystructure. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification.
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type The returnedserviceListobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
Indicates that... Theservicecompletedsuccessfully. TheserviceterminatedonaSOAPfaultfromthe UDDIserver.
610
33 UDDI Folder
TheservicedidnotcompleteduetoanHTTP connectionerror,forexample,HTTP 404. Theservicedidnotcompleteduetoanothererror condition,forexample,ServiceException.
-1
pub.uddi.client.inquiry:find_serviceByCategory
WmUDDI.Locatesspecificserviceswithinaregisteredpub.uddi.client.doc:businessEntity basedonlistofcategorykeyidentifiers. TheservicereturnsaserviceListmessagethatmatchestheconditionsspecifiedinthe arguments. Input Parameters inquiryURL maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type Listofcategoryreferences.
categoryBag Output Parameters rawXMLResponse Document SOAPFault status
String RawXMLresponsefromtheUDDIserver. Document type The returnedserviceListobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
611
33 UDDI Folder
pub.uddi.client.inquiry:find_serviceByName
WmUDDI.Locatesspecificserviceswithinaregisteredpub.uddi.client.doc:businessEntity basedonlistofservicenames. TheservicereturnsaserviceListmessagethatmatchestheconditionsspecifiedinthe arguments. Input Parameters inquiryURL Document maxRows ServiceNameList findQualifiers String URLindicatingthepathoftheUDDIserver. Document type StorestheserviceListobject. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Listofnamesofservicestobesearched. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification.
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type The returnedserviceListobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
612
33 UDDI Folder
pub.uddi.client.inquiry:find_serviceBytModel
WmUDDI.Locatesspecificserviceswithinaregisteredpub.uddi.client.doc:businessEntity basedonlistoftModelreferences. TheservicereturnsaserviceListmessagethatmatchestheconditionsspecifiedinthe arguments. Input Parameters inquiryURL maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type[pub.uddi.client.doc:tModelBag]ListoftModelUUIDkeys thatrepresentthetechnicalfingerprintofabindingTemplate.
tModelBag Output Parameters rawXMLResponse Document SOAPFault status
String RawXMLresponsefromtheUDDIserver. Document type The returnedserviceListobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
613
33 UDDI Folder
pub.uddi.client.inquiry:find_tModel
WmUDDI.LocatesoneormoretModelinformationstructuresmatchingthesetof specificcriteria. TheresponseisreturnedinthetModelListmessage. Input Parameters inquiryURL tModelName maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String Optional.tModelname. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type Optional.Listofbusinessidentifierreferences. Document type Optional.Listofcategoryreferences.
identifierBag categoryBag Output Parameters rawXMLResponse Document SOAPFault status
String RawXMLresponsefromtheUDDIserver. Document type The returnedtModelListobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
614
33 UDDI Folder
pub.uddi.client.inquiry:find_tModelByCategory
WmUDDI.LocatesoneormoretModelinformationstructuresbasedonlistofcategory references. ThefoundtModelinformationisreturnedinthetModelListmessage. Input Parameters inquiryURL maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type Listofcategoryreferences.
categoryBag Output Parameters rawXMLResponse Document SOAPFault status
0 1
-1
615
33 UDDI Folder
pub.uddi.client.inquiry:find_tModelByIdentity
WmUDDI.LocatesoneormoretModelinformationstructuresbasedonlistofbusiness identityreferences. ThefoundtModelinformationisreturnedinthetModelListmessage. Input Parameters inquiryURL maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification. Document type Optional.Listofbusinessidentifierreferences.
identifierBag Output Parameters rawXMLResponse Document SOAPFault status
0 1
Indicates that... Theservicecompletedsuccessfully. TheserviceterminatedonaSOAPfaultfrom theUDDIserver. TheservicedidnotcompleteduetoanHTTP connectionerror,forexample,HTTP 404. Theservicedidnotcompleteduetoanother errorcondition,forexample, ServiceException.
-1
616
33 UDDI Folder
pub.uddi.client.inquiry:find_tModelByName
WmUDDI.LocatesoneormoretModelinformationstructuresbasedonlistofbusiness identityreferences. ThefoundtModelinformationisreturnedinthetModelListmessage. Input Parameters inquiryURL tModelName maxRows findQualifiers String URLindicatingthepathoftheUDDIserver. String Optional.tModelname. String Optional.Maximumnumberofresultsreturnedinresponse toaservicecall. String List Optional.FindQualifierelementstoalterthedefault behaviorofsearchfunctionality.DetailsaboutfindQualifieris availableinAppendixEoftheUDDIspecification.
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type The returnedtModelListobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
617
33 UDDI Folder
pub.uddi.client.inquiry:get_bindingDetail
WmUDDI.Retrievesfullbindingtemplateinformationsuitableformakingoneormore servicerequests. TheinformationisreturnedinbindingDetailmessage. Input Parameters inquiryURL bindingKeyList String URLindicatingthepathoftheUDDIserver. String List OneormoreUUIDkeyvaluesthatrepresenttheUDDI assignedkeysforspecificinstancesofregisteredbindingTemplate data.
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type The returnedbindingDetailobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
pub.uddi.client.inquiry:get_businessDetail
WmUDDI.Retrievesthefullpub.uddi.client.doc:businessEntityinformationforoneormore businessesororganizations. TheinformationisreturnedinthebusinessDetaildocumenttype. Input Parameters inquiryURL businessKeyList String URLindicatingthepathoftheUDDIserver. String List OneormoreUUIDkeyvaluesthatrepresentUDDI assignedbusinessKeyvaluesforspecificinstancesofknown pub.uddi.client.doc:businessEntitydata.
618
33 UDDI Folder
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type The returnedbusinessDetailobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
pub.uddi.client.inquiry:get_businessDetailExt
WmUDDI.Retrievesextendedpub.uddi.client.doc:businessEntityinformationforoneormore specifiedpub.uddi.client.doc:businessEntityregistrations. Thismessagereturnsexactlythesameinformationastheget_businessDetaildocument, butmaycontainadditionalattributesifthesourceisanexternalregistry(forexample, notanOperatorSite)thatiscompatiblewiththisAPIspecification. Input Parameters inquiryURL businessKeyList String URLindicatingthepathoftheUDDIserver. String List OneormoreUUIDkeyvaluesthatrepresentUDDI assignedbusinessKeyvaluesforspecificinstancesofknown pub.uddi.client.doc:businessEntitydata.
Output Parameters rawXMLResponse Document SOAPFault String RawXMLresponsefromtheUDDIserver. Document type The returnedbusinessDetailobject. Document type SOAPFaultinformation.
619
33 UDDI Folder
status

0 1
-1
pub.uddi.client.inquiry:get_serviceDetail
WmUDDI.RetrievesfulldetailsforagivensetofregisteredbusinessServicedata. ThedataisreturnedinserviceDetaildocument. Input Parameters inquiryURL serviceKeyList String URLindicatingthepathoftheUDDIserver. String List TheUUIDkeyvaluesthatrepresentUDDIassigned serviceKeyvaluesofspecificinstancesofknownbusinessService data.
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type The returnedserviceDetailobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
620
33 UDDI Folder
Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:findAllServicesOfBusiness
pub.uddi.client.inquiry:get_tModelDetail
WmUDDI.RetrievesfulldetailsforagivensetofregisteredtModeldata. TheservicereturnsatModelDetailmessage. Input Parameters inquiryURL tModelKeyList String URLindicatingthepathoftheUDDIserver. String List OneormoreURNqualifieduuid_keyvaluesthat representUDDIassignedtModelKeyvaluesofspecificinstancesof knowntModeldata.
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturnedtModelDetailobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
621
33 UDDI Folder
pub.uddi.client.publish:add_publisherAssertions
WmUDDI.Addsrelationshipassertionstotheexistingsetofassertions. Input Parameters publishURL authInfo publisherAssertionList Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturneddispositionReportobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
String URLindicatingthepathoftheUDDIserver. String Authenticationtoken. Document type Oneormorerelationshipassertions.
-1
pub.uddi.client.publish:delete_binding
WmUDDI.DeletesoneormoreinstancesofbindingTemplatedatafromtheUDDI registry. Input Parameters publishURL authInfo bindingKeyList String URLindicatingthepathoftheUDDIserver. String Authenticationtoken. String List OneormoreUUIDkeyvaluesthatrepresentspecific instancesofknownbindingTemplatedata.
622
33 UDDI Folder
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturneddispositionReportobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
pub.uddi.client.publish:delete_business
WmUDDI.Removesoneormorebusinessregistrations(forexample,registered pub.uddi.client.doc:businessEntitydata)andalldirectcontentsfromaUDDIregistry. Input Parameters publishURL authInfo businessKeyList Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturneddispositionReportobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
String URLindicatingthepathoftheUDDIserver. String Authenticationtoken. String List OneormoreUUIDkeyvaluesthatrepresentspecific instancesofknownpub.uddi.client.doc:businessEntitydata.
623
33 UDDI Folder
-1
Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:deleteMyBusiness
pub.uddi.client.publish:delete_publisherAssertions
WmUDDI.RemovesoneormorepublisherAssertionelementstoberemovedfroma publishersassertioncollection. Input Parameters publishURL authInfo publisherAssertionList String URLindicatingthepathoftheUDDIserver. String Authenticationtoken. Document type Oneormorerelationshipassertionstructures exactlymatchinganexistingassertionthatcanbefoundinthe publishersassertion.
0 1
-1
624
33 UDDI Folder
pub.uddi.client.publish:delete_service
WmUDDI.RemovesoneormorepreviouslybusinessServiceelementsfromtheUDDI registryandfromitscontainingpub.uddi.client.doc:businessEntityparent. Input Parameters publishURL authInfo serviceKeyList Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturneddispositionReportobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
String URLindicatingthepathoftheUDDIserver. String Authenticationtoken. String List OneormoreUUIDkeyvaluesthatrepresentspecific instancesofknownbusinessServicedata.
-1
pub.uddi.client.publish:delete_tModel
WmUDDI.LogicallydeletesoneormoretModelstructures.Logicaldeletionhidesthe deletedtModelsfromfind_tModelresultsets,butdoesnotphysicallydeleteit. DeletinganalreadydeletedtModelhasnoeffect. Input Parameters publishURL authInfo TmodelKeyList String URLindicatingthepathoftheUDDIserver. String Authenticationtoken. String List OneormoreURNqualifiedUUIDkeyvaluesthat representUDDIassignedtModelKeyvaluesofspecificinstancesof knowntModeldata.
625
33 UDDI Folder
0 1
-1
pub.uddi.client.publish:discard_authToken
WmUDDI.InformsanOperatorSitethattheauthenticationtokenistobediscarded, effectivelyendingthesession. SubsequentcallsthatusethesameauthTokenwillberejected. Thismessageisoptional forOperatorSitesthatdonotmanagesessionstateorthatdonotsupportthe get_authTokenmessage. Input Parameters publishURL authInfo Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturneddispositionReportobject. Document type SOAPFaultinformation. String StatusofthisAPIcall. A value of...
0 1
String URLindicatingthepathoftheUDDIserver. String Authenticationtoken.
626
33 UDDI Folder
-1
Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:deleteMyBusiness samples.uddi.client:publishMyBinding samples.uddi.client:publishMyBusiness samples.uddi.client:publishMyService
pub.uddi.client.publish:get_assertionstatusReport
WmUDDI.Providesadministrativesupportfordeterminingthestatusofcurrentand outstandingpublisherassertionsthatinvolveanyofthebusinessregistrationsmanaged bytheindividualpublisheraccount. Usingthismessage,apublishercanseethestatusofassertionsthattheyhavemade,as wellasseeassertionsthatothershavemadethatinvolvepub.uddi.client.doc:businessEntity structurescontrolledbythecallingpublisheraccount. Input Parameters publishURL authInfo completionstatus String URLindicatingthepathoftheUDDIserver. String Authenticationtoken. StringOptional.Oneofthefollowingvalues: Value
status:complete
Description Returnsonlythepublisher assertionsthatarecomplete. Returnsonlythosepublisher assertionswherethepartythat controlsthe pub.uddi.client.doc:businessEntity referencedbythetoKeyvaluehasnot madeamatchingassertion.
627
33 UDDI Folder
Returnsonlythosepublisher assertionswherethepartythat controlsthe pub.uddi.client.doc:businessEntity referencedbythefromKeyvaluehas notmadeamatchingassertion.
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturnedassertionstatusReportobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
pub.uddi.client.publish:get_authToken
WmUDDI.Obtainsanauthenticationtoken. AuthenticationtokensareopaquevaluesthatarerequiredforallotherpublisherAPI calls. ThisAPIisprovidedforimplementationsthatdonothavesomeothermethodof obtaininganauthenticationtokenorcertificate,orthatchoosetouseuserIDand passwordbasedauthentication. Input Parameters publishURL uddiUserID uddiPassword StringURLindicatingthepathoftheUDDIserver. StringUserIDthattheindividualauthorizeduserwasassignedby anOperatorSite. StringThepasswordorcredentialthatisassociatedwiththeuser ID.
628
33 UDDI Folder
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturnedauthTokenobject. Document type SOAPFaultinformation. String StatusofthisAPIcall. A value of...
0 1
-1
Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:deleteMyBusiness samples.uddi.client:publishMyBinding samples.uddi.client:publishMyBusiness samples.uddi.client:publishMyService
pub.uddi.client.publish:get_publisherAssertions
WmUDDI.Obtainsthefullsetofpublisherassertionsthatisassociatedwithan individualpublisheraccount. Input Parameters publishURL authInfo Output Parameters rawXMLResponse Document SOAPFault String RawXMLresponsefromtheUDDIserver. Document type ThereturnedpublisherAssertionsobject. Document type SOAPFaultinformation. StringURLindicatingthepathoftheUDDIserver. StringAuthenticationtoken.
629
33 UDDI Folder
status

0 1
-1
pub.uddi.client.publish:get_registeredInfo
WmUDDI.Getsanabbreviatedlistofallpub.uddi.client.doc:businessEntityandtModeldata thatarecontrolledbytheindividualassociatedwiththecredentialspassed. Input Parameters publishURL authInfo Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturnedregisteredInfoobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
StringURLindicatingthepathoftheUDDIserver. StringAuthenticationtoken.
-1
630
33 UDDI Folder
pub.uddi.client.publish:save_binding
WmUDDI.SavesorupdatesacompletebindingTemplateelement. ThismessagecanbeusedtoaddorupdateoneormorebindingTemplateelementsas wellasthecontainer/containedrelationshipthateachbindingTemplatehaswithoneor moreexistingbusinessServiceelements. Input Parameters publishURL authInfo bindingTemplateList Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturnedbindingDetailobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
StringURLindicatingthepathoftheUDDIserver. StringAuthenticationtoken. Document type OneormorecompletebindingTemplateelements.
-1
Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:publishMyBinding
631
33 UDDI Folder
pub.uddi.client.publish:save_business
WmUDDI.Savesorupdatesinformationaboutacompletepub.uddi.client.doc:businessEntity element. Thepub.uddi.client.publish:save_businessservicehasthebroadestscopeofallofthesave_xx services,andcanbeusedtomakesweepingchangestothepublishedinformationforone ormorepub.uddi.client.doc:businessEntityelements. Input Parameters publishURL authInfo businessEntityList Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturnedbusinessDetailobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
StringURLindicatingthepathoftheUDDIserver. StringAuthenticationtoken. Document type Oneormorecompletepub.uddi.client.doc:businessEntity elements.
-1
Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:publishMyBusiness
632
33 UDDI Folder
pub.uddi.client.publish:save_service
WmUDDI.AddsorupdatesoneormorebusinessServiceelements. Input Parameters publishURL authInfo businessServiceList Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturnedserviceDetailobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
StringURLindicatingthepathoftheUDDIserver. StringAuthenticationtoken. Document type OneormorecompletebusinessServiceelementscan bepassed.
-1
Examples SeethefollowingintheSamplesfolderintheWmUDDIpackage: samples.uddi.client:publishMyService
633
33 UDDI Folder
pub.uddi.client.publish:save_tModel
WmUDDI.AddsorupdatesoneormoreregisteredtModelelements. Input Parameters publishURL authInfo tModelList Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUDDIserver. Document type ThereturnedtModelDetailobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
StringURLindicatingthepathoftheUDDIserver. StringAuthenticationtoken. Document type OneormorecompletetModelelementscanbe passed.
-1
pub.uddi.client.publish:set_publisherAssertions
WmUDDI.Managesallofthetrackedrelationshipassertionsassociatedwithan individualpublisheraccount. Input Parameters publishURL authInfo PublisherAssertionList StringURLindicatingthepathoftheUDDIserver. StringAuthenticationtoken. Document type Optional.Zeroormorerelationshipassertions.
634
33 UDDI Folder
Output Parameters rawXMLResponse Document SOAPFault status String RawXMLresponsefromtheUsamples.uddi.client.DDI server. Document type ThereturnedpublisherAssertionsobject. Document type SOAPFaultinformation. String Statusofthisservice. A value of...
0 1
-1
635
33 UDDI Folder
636
34
UniversalName Folder
YouusetheelementsintheuniversalNamefoldertolistthecontentsoftheUniversal Registryandtolookupservicesbytheiruniversalnames.
637
34 UniversalName Folder

Thefollowingelementsareavailableinthisfolder: Element pub.universalName:find pub.universalName:list Package and Description WmPublic.Returnsthefullyqualifiedservicenameforan explicituniversalname. WmPublic.Returnsthecontentsofthecurrentuniversal nameregistry.
pub.universalName:find
WmPublic.Returnsthefullyqualifiedservicenameforanexplicituniversalname. Input Parameters namespaceName localName Output Parameters svcName StringConditional.Fullyqualifiednameoftheserviceassociated withtheuniversalnameinnamespaceNameandlocalName.Ifthe specifieduniversalnameisnotintheregistry,svcNamewillbenull. StringNamespaceportionoftheuniversalname. StringLocalportionoftheuniversalname.
pub.universalName:list
WmPublic.Returnsthecontentsofthecurrentuniversalnameregistry. Input Parameters None.
638
Output Parameters names Document ListEntriesintheuniversalnameregistry.Eachdocument (IDataobject)inthelistrepresentsanentryintheuniversalname registry.(Thereisoneentryforeveryexplicituniversalnamethathas beendefinedontheserver.Implicituniversalnamesarenot maintainedintheregistry.) Eachdocumentinthelistcontainsthefollowinginformation: Key universalName Description DocumentTheuniversalnameassociatedwiththe entry.Thisdocumentcontainsthefollowing information: Key namespaceName localName svcName Description StringNamespaceportionofthe universalname. StringLocalportionofthe universalname.
StringFullyqualifiedwebMethodsservicename associatedwiththeentry(forexample, gl.post:postEntry).
639
640
35
Utils Folder
Youusetheelementsintheutilsfoldertoretrievethevaluesofserverproperties.
641
35 Utils Folder

Thefollowingelementsareavailableinthisfolder: Element pub.utils:getServerProperty Package and Description WmUtils.Retrievesthevalueofaspecifiedserver property.
pub.utils:getServerProperty
WmUtils.Retrievesthevalueofaspecifiedserverproperty. Input Parameters propertyName defaultValue StringThenameoftheserverpropertywhosevalueyouwantto retrieve(forexample,watt.server.SOAP.directive). StringOptional.Thedefaultvaluetoreturniftheserverproperty specifiedinpropertyNamedoesnotexist.Iftheserverpropertydoes exist,getServerPropertyignoresthisvalue.
Output Parameters propertyValue StringThevalueoftherequestedserverproperty.Iftheproperty doesnotexist,andyoudidnotsetadefaultValue,getServerProperty returnsnull.
642
36
VCS Folder
YouusetheelementsintheVCSfoldertomanageuserassociationsfortheVCS Integrationfeature. Note: FormoreinformationabouttheVCSIntegrationfeature,seethe webMethods_directory\_documentationdirectoryofyourwebMethodsinstallation. Important! Theservicesinthisfolderhavebeendeprecated.Tomanageuser associationsbetweenDeveloperandaVCSserver,intheIntegrationServer Administrator,gototheSolutions > VCS > User Mappingpage.
643
36 VCS Folder

Thefollowingelementsareavailableinthisfolder: Element pub.vcs:getUsers Package and Description WmVCS.DeprecatedReturnsalistoftheDeveloperuser accountsthatareassociatedwithacorrespondingversion controlsystem(VCS)useraccountontheVCSserver. WmVCS.DeprecatedRemovesthecurrentlyloggedin Developeruseraccountfromthelistofusersassociated withaversioncontrolsystem(VCS)useraccountonthe VCSserver. WmVCS.DeprecatedRemovesthespecifiedDeveloper useraccountsfromthelistofusersassociatedwitha versioncontrolsystem(VCS)useraccount. WmVCS.DeprecatedAssociatesaversioncontrolsystem (VCS)useraccountwiththecurrentlyloggedinDeveloper useraccount.Forinformationaboutrestrictionson accountassociation,seetheUsage Notes. WmVCS.DeprecatedAssociatesaversioncontrolsystem (VCS)useraccountwiththespecifiedDeveloperuser accounts.Forinformationaboutrestrictionsonaccount association,seetheUsage Notes.
pub.vcs:removeCurrentUser
pub.vcs:removeMultipleUsers
pub.vcs:setCurrentUser
pub.vcs:setMultipleUsers
pub.vcs:getUsers
WmVCS.DeprecatedReturnsalistoftheDeveloperuseraccountsthatareassociated withacorrespondingversioncontrolsystem(VCS)useraccountontheVCSserver. Input Parameters None. Output Parameters users Document List ListofDeveloperuseraccountswithassociations toaVCSuseraccountontheVCSserver. Key devName vcsName Description StringThenameoftheDeveloperuseraccount. StringThenameoftheVCSuseraccount associatedwiththedevNameaccount.
644
36 VCS Folder
Usage Notes Thisserviceisavailableonlytoadministratorusers.
pub.vcs:removeCurrentUser
WmVCS.DeprecatedRemovesthecurrentlyloggedinDeveloperuseraccountfromthe listofusersassociatedwithaversioncontrolsystem(VCS)useraccountontheVCS server. Input Parameters None. Output Parameters None. Usage Notes Thisserviceisavailabletoallusers.Afterrunningthisservice,thecurrentlyloggedin DeveloperuseraccountisnolongerassociatedwithaVCSuseraccount.Nominally, thispreventstheDeveloperuserfromcheckingelementsintoandoutoftheVCS repository.However,onWindowsoperatingsystems,VCSactionswillstillbe submittedbytheVCSclientwiththeuserscurrentWindowsusername.Ifthe credentialsoftheWindowsuseraccountmatchthecredentialsofaVCSaccounton theVCSserver,theVCSactionswillbecompletedsuccessfully. Theuserisadvisedtocheckinallcheckedoutelementsbeforerunningthisservice. TheVCSIntegrationfeaturewillnotpermitanelementtobecheckedinbyotherthan theuserwhocheckeditout.ThisservicehasnoeffectontheVCSuseraccount.
pub.vcs:removeMultipleUsers
WmVCS.DeprecatedRemovesthespecifiedDeveloperuseraccountsfromthelistof usersassociatedwithaversioncontrolsystem(VCS)useraccount. Input Parameters devNames Output Parameters None. String ListThenamesoftheDeveloperuseraccounts.
645
36 VCS Folder
Usage Notes Thisserviceisavailableonlytoadministratorusers.Theuseraccountnameiscase sensitive.Afterrunningthisservice,theDeveloperuseraccountsspecifiedinthe inputparametersarenolongerassociatedwithaVCSuseraccount.Nominally,this preventsthespecifiedDeveloperusersfromcheckingelementsintoandoutofthe VCSrepository.However,onWindowsoperatingsystems,VCSactionswillstillbe submittedbytheVCSclientwiththeuserscurrentWindowsusername.Ifthe credentialsoftheWindowsuseraccountmatchthecredentialsofaVCSaccounton theVCSserver,theVCSactionswillbecompletedsuccessfully. Administratorsareadvisedtoverifythatallelementscheckedoutbythespecified Developerusersarecheckedinbeforerunningthisservice.TheVCSIntegration featurewillnotpermitanelementtobecheckedinbyotherthantheuserwho checkeditout.ThisservicehasnoeffectontheVCSuseraccount.
pub.vcs:setCurrentUser
WmVCS.DeprecatedAssociatesaversioncontrolsystem(VCS)useraccountwiththe currentlyloggedinDeveloperuseraccount.Forinformationaboutrestrictionson accountassociation,seetheUsage Notes. Input Parameters vcsName vcsPassword Output Parameters None. Usage Notes Thisserviceisavailabletoallusers.ADeveloperusernamedoesnothavetobethe sameastheassociatedVCSserverusername,andalluseraccountcredentialsare casesensitive.EachDeveloperusercanhaveoneVCSuseraccountassociatedwith theDeveloperuseraccount.AlthoughitispossibleformorethanoneDeveloperuser tobeassociatedwiththesameVCSuseraccount,Software AGrecommendsthatyou avoidthisconfigurationasitmayresultinerrorsorunpredictableresults. Afterrunningthisservice,thecurrentlyloggedinDeveloperuseraccountis associatedwithauseraccountontheVCSserver,enablingtheDeveloperuserto checkelementsintoandoutoftheVCSrepository(withproperACLpermissions). Thisassociationismaintaineduntilitisremovedwiththepub.vcs:removeCurrentUseror pub.vcs:removeMultipleUsersservices.Thisservicedoesnotvalidate,create,ormodify VCSserveraccounts. StringThenameofanexistingVCSuseraccountontheVCSserver. StringThepasswordoftheVCSuseraccountspecifiedinvcsName.
646
36 VCS Folder
pub.vcs:setMultipleUsers
WmVCS.DeprecatedAssociatesaversioncontrolsystem(VCS)useraccountwiththe specifiedDeveloperuseraccounts.Forinformationaboutrestrictionsonaccount association,seetheUsage Notes. Input Parameters devNames Document ListInformationrequiredtoassociateeachDeveloperuser accountwithaVCSuseraccountontheVCSserver: Key devName vcsName vcsPassword Output Parameters None. Usage Notes Thisserviceisavailableonlytoadministratorusers.ADeveloperusernamedoesnot havetobethesameastheassociatedVCSserverusername,andtheuseraccount nameiscasesensitive.EachDeveloperusercanhaveoneVCSuseraccount associatedwiththeDeveloperuseraccount.Althoughitispossibleformorethanone DeveloperusertobeassociatedwiththesameVCSuseraccount,Software AG recommendsthatyouavoidthisconfigurationasitmayresultinerrorsorunpredictable results. Afterrunningthisservice,theDeveloperuseraccountsspecifiedintheinput parametersareassociatedwithacorrespondinguseraccountontheVCSserver, enablingtheDeveloperuserstocheckelementsintoandoutoftheVCSrepository (withproperACLpermissions).Thisassociationismaintaineduntilitisremoved withthepub.vcs:removeCurrentUserorpub.vcs:removeMultipleUsersservices.Thisservice doesnotvalidate,create,ormodifyVCSserveraccounts. Description String ThenameoftheDeveloperuseraccount. String ThenameofanexistingVCSuseraccounton theVCSserver. String ThepasswordoftheVCSuseraccount specifiedinvcsName.
647
36 VCS Folder
648
37
XML Folder
YouusetheelementsinthexmlfoldertoperformoperationsonXMLdocuments.
649
37 XML Folder

Thefollowingelementsareavailableinthisfolder: Element pub.xml:documentToXMLString pub.xml:freeXMLNode pub.xml:getNextXMLNode pub.xml:getXMLNodeIterator pub.xml:getXMLNodeType pub.xml:loadXMLNode Package and Description WmPublic. Converts a document (IData object) to an XML string. WmPublic.Freestheresourcesallocatedtoa givenXMLnode. WmPublic.GetsthenextXMLnodefroma NodeIterator. WmPublic.CreatesandreturnsaNodeIterator. WmPublic.ReturnsinformationaboutanXML node. WmPublic.RetrievesanXMLdocumentvia HTTPorHTTPS,parsesit,andproducesanXML node. WmPublic.QueriesanXMLnode. WmPublic.ConvertsanXMLnodetoadocument (anIDataobject). WmPublic.ConvertsanXMLdocument (representedasaString,byte[ ],orInputStream) toanXMLnode.
pub.xml:queryXMLNode pub.xml:xmlNodeToDocument pub.xml:xmlStringToXMLNode
pub.xml:documentToXMLString
WmPublic.Convertsadocument(IDataobject)toanXMLstring. Thisservicerecursesthroughagivendocument,buildinganXMLrepresentationfrom theelementswithinit.KeynamesareturnedintoXMLelements,andthekeyvaluesare turnedintothecontentsofthoseelements.
650
37 XML Folder
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-7417566</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>
Notethat: Keynamesthatstartwiththeattributeprefix(which,inthisexample,isthe@ character)areturnedintoattributesoftheelementsinwhichtheyoccur.Forexample, the@typekeyintheacctNumelementisconvertedtothetype=platinumattributeof the<acctNum>elementintheresultingXMLString. Alsonotethatthe*bodykeyisusedtorepresentthevalueofasimpleelementthat containsbothatextvalueandanattribute.SeetheacctNumandphoneNumkeysforan exampleofthiskindofelement. FieldsthatarenotStringorDocumentbased(forexample,FloatsorIntegers)are convertedtoXMLvaluesusingtheunderlyingobjectstoStringmethod.
651
37 XML Folder
Input Parameters attrPrefix StringOptional.Prefixthatdesignateskeyscontaining attributes.Thedefaultprefixis@. Forexample,ifyousetattrPrefixtoATT_anddocument containedthefollowingelement:
documentToXMLStringwouldconverttheATT_currencykeytothe attribute,currency=dollars,inthe<tx>elementasshown below:

<tx currency=dollars> <acct>cash</acct> <amt>120.00</amt> </tx>
document
DocumentIDataobjectthatistobeconvertedtoXML.Note thatifyouwanttoproduceavalidXMLdocument(onewitha singlerootnode),documentmustcontainonlyonetoplevel IDataobject(thatis,asingledocument).Thenameofthat documentwillserveasthenameoftheXMLdocumentsroot element. Forexample,documentshownintheexampleinthisservices descriptioncontainsonetopleveldocumentnamedAcctInfo, whichwouldresultinonerootelementnamed<AcctInfo>in theresultingXMLString. IfyouneededtoproduceanXMLfragment(forexample,a loosecollectionofelementsthatarenotencompassedwithina singlerootelement)thendocumentcancontainmultipletop levelelements.Toproducethistypeofoutput,youmustalso settheaddHeaderandenforceLegalXMLparameterstofalse.
nsDecls
DocumentOptional.Namespacesassociatedwithany namespaceprefixesthatareusedinthekeynamesin document.EachentryinnsDeclsrepresentsanamespace prefix/URIpair,whereakeynamerepresentsaprefixandthe valueofthekeyspecifiesthenamespaceURI. Forexample,todefinetheURIsassociatedwithtwoprefixes calledGSX andTxMon,youwouldsetnsDeclsasfollows:
652
37 XML Folder
ForeachprefixspecifiedinnsDecls,documentToXMLString generatesanxmlnsattributeandinsertsitintothetopmost elementoftheresultingXMLString.Forexample,ifnsDecls hadthetwokeysshownabove,documentToXMLStringwould insertthefollowingattributesintotherootelementofthe XMLString:

xmlns:gsx="http://www.gsx.com" xmlns:TxMon="http:www.acrtrak/txMonitor"
Note: Youcanalsoincludeanamespacedeclarationby includingan@xmlnskeyindocument(ifyouwerentusingthe@ charactertodesignateattributes,usethecorrectattribute prefixinyourcode).Theadvantageofthisapproachover nsDeclsisthatitletsyouspecifythepointwhereyouwantthe xmlnsattributetobeinserted. addHeader StringOptional.Flagspecifyingwhethertheheaderelement:

<?xml version=1.0?>
istobeincludedintheresultingXMLString. Set to...

true false
To... Default.Includetheheader. Omittheheader.(Youwouldomittheheader togenerateanXMLfragmentortoinserta customheader.)
encode
StringOptional.FlagindicatingwhethertoHTMLencodethe data.SetthisparametertotrueifyourXMLdatacontains specialcharacters,includingthefollowing:< > & " ' Set to...

true
To... HTMLencodethedata. Forexample,thestringexpression5 < 6 wouldbeconvertedto<expr>5 < 6</expr>,whichisvalid.
false
Default.DonotHTMLencodethedata. Forexample,thestringexpression5 < 6 wouldbeconvertedto<expr>5 < 6</expr>, whichisinvalid.
653
37 XML Folder
documentTypeName
StringOptional.Fullyqualifiednameofthedocumenttype thatdescribesthestructureandformatoftheoutput document(forexample,examples.rtd:exampleRecord1). Youcanusethisparametertoensurethattheoutputincludes elementsthatmightnotbepresentindocumentatruntime,or todescribetheorderinwhichelementsaretoappearinthe resultingXMLString.
generateRequiredTags
StringOptional.Flagindicatingwhetheremptytagsaretobe includedintheoutputdocumentifamandatoryelement appearsinthedocumenttypespecifiedindocumentTypeName butdoesnotappearindocument. Set to...

true
To... Includemandatoryelementsiftheyarenot presentindocument. Default.Omitmandatoryelementsiftheyare notpresentindocument.
false
enforceLegalXML
StringOptional.Flagindicatingwhethertheservicethrowsan exceptionwhendocumentcontainsmultiplerootelementsor illegalXMLtagnames. Set to...

true
To... Throwanexceptionifdocumentwould produceanXMLStringcontainingmultiple rootelementsand/orillegalXMLtagnames. Default.AllowtheresultingXMLStringto containmultiplerootelementsand/orillegal XMLtagnames.Youwouldusethissetting, forexample,tocreateanXMLfragment composedofmultipleelementsthatwerenot allenclosedwithinarootelement.
false
dtdHeaderInfo
DocumentOptional.ContentsoftheDOCTYPEheadertobe insertedintotheXMLString.(Youcanretrievethis informationfromanincomingdocumentusing pub.xml:getXMLNodeType.) Key systemID publicID rootNSPrefix Description StringOptional.Systemidentifierforthe DTD,ifany. StringOptional.PublicidentifierfortheDTD, ifany. StringOptional.Namespaceprefixofthe rootLocalName,ifany.
654
37 XML Folder
rootLocalName bufferSize
StringOptional.Localname(excludingthe namespaceprefix)oftherootelement.
StringOptional.Initialsize(inbytes)oftheStringbufferthat documentToXMLStringusestoassembletheoutputXMLString.If theStringbufferfillsupbeforedocumentToXMLStringisfinished generatingtheXMLString,itreallocatesthebuffer,expanding itbythisamounteachtimethebufferbecomesfull. IfyoudonotsetbufferSize,documentToXMLStringlookstosee whetheradefaultbuffersizeisspecifiedinthefollowing parameterontheserver:

watt.server.recordToDocument.bufferSize
Ifso,itusesthisvaluetoallocatetheStringbuffer.Ifthis parameterisnotset,documentToXMLStringusesadefaultbuffer sizeof4096bytes. Forbestperformance,youshouldalwayssetbufferSizetoa valuethatcloselymatchesthesizeoftheXMLStringthatyou expectdocumentToXMLStringtoproduce.Thispracticewillspare theserverfromhavingtoenlargethebufferrepeatedlyifthe XMLStringismanytimeslargerthanthedefaultbufferorif youarbitrarilysetbufferSizetoavaluethatistoosmall. SettingbufferSizetoanappropriatelysizedvaluewillalso preventyourservicefromunnecessarilyconsumingmore memorythanitneedsiftheXMLStringismuchsmallerthan thedefaultbuffersizeorifyouarbitrarilysetbufferSizetoa valuethatistoolarge. Output Parameters xmldata Usage Notes IfyouarebuildinganIDatathatwillbeconvertedtoanXMLString,keepthe followingpointsinmind: Ifyouwanttogenerateasimpleelementthatcontainsonlyacharactervalue, representitwithaStringelementindocumentasshowninthefollowing: StringXMLStringproducedfromdocument.
655
37 XML Folder
Ifyouwanttogenerateanelementthatcontainschildren,representwithanIData indocumentasshowninthefollowing.
Toproduceattributes,puttheattributevaluesinkeyswhosenamestartswiththe character(s)specifiedinattrPrefix.Forexample,ifyouusethedefaultattrPrefix, thenamesofallkeyscontainingattributes(andonlythosekeyscontaining attributes)muststartwiththe@character(forexample,@type,@xmlns). Also,whenyouincludeattributes,makesurethatkeysrepresentingattributesare directchildrenoftheelementsinwhichtheyaretobeapplied.Forexample,if youwanttoincludeanxmlnsattributeinthe<AcctInfo> elementintheexample showninthedescriptionofthisservice,youmustcreateaStringfieldnamed @xmlnsintheAcctInfofieldwithindocument. Ifyouwanttogenerateasimpleelementthatcontainsacharactervalueandone ormoreattributes,youmustrepresentitasanIDatathathasonekeyforeach attributeandakeynamed*bodythatcontainselementsvalue.Forexample,ifyou wantedtoproducethefollowingelement:
<phoneNum cc=011>216-741-7566</phoneNum>
Youwouldincludethefollowingindocument:
Toincludenamespaces,makesureyoudothefollowing: Includetheappropriatenamespaceprefixinthekeynamesindocument.For example,toproduceanelementcalledacctNumthatbelongstoanamespace thatisrepresentedbytheGSXprefix,youwouldincludeakeynamed GSX:acctNumindocument. DefinetheURIsfortheprefixesthatappearindocument.Youcandothis throughnsDeclsorbyincludingan@xmlnskeyintheelementwhereyouwant thexmlnsattributetobeinserted.SeethensDeclsdescriptionaboveformore informationaboutdeclaringnamespaces. ToreturntheprocessedXMLdocumenttotheclientthatoriginallysubmittedit, invokepub.flow:setResponse.Keepinmindthatyoumayneedtomodifytheencoding.
656
37 XML Folder
pub.xml:freeXMLNode
WmPublic.FreestheresourcesallocatedtoagivenXMLnode. YoucanoptionallycallthisservicewhenyouareusingaNodeIteratortoiterateoveran XMLnodeandyoudecidetostopprocessingthenodebeforereachingtheend.By explicitlycallingpub.xml:freeXMLNode,youimmediatelyfreetheresourcesassociatedwith thenodeinsteadofwaitingforJavagarbagecollectiontodothis.Althoughitisnot mandatorytocallthisservicewhenyoufinishprocessinganXMLnodewitha NodeIterator,doingsocanboostserverperformance.Notethatafteryouhavefreedan XMLnodeusingthisservice,thenodebecomesunstableandshouldnotbeusedbyany subsequentprocesses. Input Parameters rootNode Output Parameters None. com.wm.lang.xml.DocumentXMLnodewhoseresourcesyouwantto release.
pub.xml:getNextXMLNode
WmPublic.GetsthenextXMLnodefromaNodeIterator. Input Parameters iterator com.wm.app.b2b.util.NodeIteratorNodeIteratorfromwhichtoretrievethe nextnode.
Output Parameters next DocumentConditional.Therequestednode.Willbenullwhenthe NodeIteratorhasnomorenodestoreturn.Otherwise,nextwillcontain thefollowing: Key name Description StringElementtypenameofthenode.Iftheelement belongstoanamespaceandthenamespacewasdeclaredat thetimetheNodeIteratorwasconstructed,namewillhave theprefixdeclaredforthatnamespace.Ifthenamespaceis notdeclared,namewilluseprefixthatoccursintheXML.
657
37 XML Folder
node
com.wm.lang.xml.NodeXMLnodeidentifiedbytheinput criteriausedtooriginallygeneratetheNodeIterator.
ItispossiblethatallcallstogetNextXMLNodeonagivenNodeIteratorwill yieldthesamedocumentinstance,wherethevaluesoftheinstances entriesvary.Forthisreason,applicationsshouldassumethateachcall togetNextXMLNodeinvalidatesthedocumentreturnedbytheprevious call.Thisapproachmaximizesthespeedoftheserverandminimizes theuseofresources. Usage Notes ANodeIteratorisacquiredviatheserviceUsage Notes.Theoutputofthatserviceisa document(IDataobject)containingtheelementtypenameofthenodeandthenode itself.TheinstanceofthisdocumentisonlyvaliduntilthenextgetNextXMLNodecallon thesameNodeIterator,becausegetNextXMLNodeusesthesamedocumentobjectfor eachcall.
pub.xml:getXMLNodeIterator
WmPublic.CreatesandreturnsaNodeIterator. ANodeIteratoriteratesovertheelementnodedescendantsofanXMLnodeandreturns theelementnodesthatsatisfythegivencriteria.Theclientapplicationorflowservice usestheservicepub.xml:getNextXMLNodetogeteachnodeinturn.NodeIteratorscanonlybe createdforXMLnodes(notforHTMLnodes). getXMLNodeIteratorisusefulforloadingandparsingdocumentsondemand.Largeorslow documentsneedonlybeloadedasfarasneededtogetthedesireddata.NodeIterators arealsousefulforprovidingserviceasthepertinentinformationinthedocumentarrives ratherthanfirstwaitingfortheentiredocumenttoload.Thisserviceisprimarily intendedtodealwithlargedocumentsordocumentsthatarriveslowly. NodeIteratorprovidesamovingwindowmode,inwhichtheonlynodethatisresident inmemoryisthelastnodereturnedbypub.xml:getNextXMLNode.Inthismode,when pub.xml:getNextXMLNodeiscalled,allnodesprecedingthenewlyreturnednodebecome invalid,includingallnodespreviouslyreturnedbypub.xml:getNextXMLNode.Theclient mustfullycompleteprocessingprecedingnodesbeforeadvancingthewindowbycalling pub.xml:getNextXMLNodeagain.Inmovingwindowmode,thedocumentconsumesatleast enoughmemorytoholdthemostrecentlyreturnednode. MovingwindowmodeallowstheservertoprocessmultimegabyteXMLdocuments usingverylittlememory.Movingwindowmodemayonlybeusedonanodethat representsanentireXMLdocumentandnotonanydescendantnode.
658
37 XML Folder
Input Parameters node com.wm.lang.xml.NodeXMLnodeforwhichyouwanttoproducea NodeIterator.ThenodecanrepresenteitheranXMLdocumentoran elementofanXMLdocument;however,iftheNodeIteratorwillbe usedinmovingwindowmode,awholeXMLdocumentmustbe used.Thisisbecausemovingwindowmodeisonlymeaningfulfor managingtheloadingprocessofadocument,andtooperateona nodeistohavealreadyloadedthenode. String ListOptional.Patternstringsidentifyingthenodesthatthe iteratoristoreturn.Apatternstringmaytakeeithertheform <localName>ortheform<prefix>:<localName>. Whenapatterntakesthefirstform,itidentifiesanelementwhose localnameis<localName>andthatbelongstothedefaultXML namespace.Whenapatterntakesthesecondform,itidentifiesan elementwhoselocalnameis<localName>andwhoseXML namespaceisgivenbytheprefix<prefix>.Iftheinputparameter nsDeclsdeclaresthisprefix,thenamespaceURIoftheelementmust matchtheURIdeclaredfortheprefix.Iftheprefixisnotdeclaredin nsDecls,theprefixismatchedagainstprefixesfoundintheXML.
<prefix>and<localName>caneachoptionallytakethevalue* (asterisk)tomatchanynamespaceorlocalname.A*prefixalso
criteria
matcheselementsresidinginthedefaultnamespace. Ifyoudonotspecifycriteria,allelementnodechildrenoftheroot elementarereturned. nsDecls DocumentOptional.Namespacesassociatedwithanynamespace prefixesusedincriteria.EachentryinnsDeclsrepresentsa namespaceprefix/URIpair,whereakeynamerepresentsaprefix andthevalueofthekeyspecifiesthenamespaceURI. Forexample,todefinetheURIsassociatedwithtwoprefixescalled GSX andTxMon,youwouldsetnsDeclsasfollows:
659
37 XML Folder
movingWindow
StringOptional.FlagindicatingwhethertheNodeIteratoristo iterateusingamovingwindow,asdescribedabove.Inmoving windowmode,theentiredocumentprecedingthenodemost recentlyreturnedbygetXMLNodeIteratorisdiscarded.Subsequent attemptstoreturnprecedingportionsofthedocumentwillreturn eithertherepeatingtext*PURGED*ortheproperdata,dependingon whetherthedatafallswithinanareathattheserverwasableto discard.Wheniteratingwithamovingwindow,thecurrentnode shouldbequeriedandcompletelyexaminedpriortorequestingthe nextnode. Set to...
true false
To... TousetheNodeIteratorinmovingwindowmode. Default.TousetheNodeIteratorinnormalmode.
Output Parameters iterator com.wm.app.b2b.util.NodeIteratorNodeIteratorforusewiththeservice pub.xml:getNextXMLNode.
pub.xml:getXMLNodeType
WmPublic.ReturnsinformationaboutanXMLnode. Input Parameters rootNode Output Parameters systemID StringConditional.Systemidentifier,asprovidedbytheDTD associatedwithrootNode.IfrootNodedoesnothaveasystem identifier,thisvalueisnull. StringConditional.Publicidentifier,asprovidedbytheDTD associatedwithrootNode.IfrootNodedoesnothaveapublic identifier,thisvalueisnull. StringURIoftheXMLnamespacetowhichrootNodesrootelement belongs. StringConditional.NamespaceprefixofrootelementinrootNode,if any. StringConditional.Localname(excludingthenamespaceprefix)of therootelementinrootNode,ifany. com.wm.lang.xml.DocumentXMLnodeaboutwhichyouwant information.
publicID
rootNamespace rootNSPrefix rootLocalName
660
37 XML Folder
pub.xml:loadXMLNode
WmPublic.RetrievesanXMLdocumentviaHTTPorHTTPS,parsesit,andproducesan XMLnode. Input Parameters url StringTheURLofthedocumentyouwanttoload.Thisstringmust beginwithhttp:orhttps:.Forexample:
http://www.rubicon.com/orders/orders.html
OR
https://localhost:5555/WmPublic/index.html
method
StringOptional.FlagindicatingtheHTTPmethodyouwant loadXMLNodetousetoretrievetherequestedresource.Settogetor post. DocumentOptional.Authenticationandauthorizationinformation thatloadXMLNodewilluseiftherequestedresourceisprotected. Key type Description StringTypeofauthenticationloadXMLNodewill usetosubmitthisrequest.Leavethisfield blank,astheonlyoptioncurrentlyavailableis basicHTTPauthentication. StringUsernamethatloadXMLNodewillsubmit iftherequestedresourceisprotected. StringPasswordassociatedwithuser.
auth
user pass data
DocumentOptional.ThedatathatyouwantloadXMLNodetosubmit withtherequest.Specifydatausingoneormoreofthefollowing elements. Note: Whenyouusemorethanoneelementtosubmitdata,argsis appendedfirst,tableisappendedsecond,andstringisappended last.
661
37 XML Folder
Key args
Description DocumentOptional.Specifiesname=valuepairs thatloadXMLNodeistosubmittotheresourcein url. Youcanuseargstosubmitdataviaeitherthe POSTorGETmethod. Tospecifydatausingargs,createoneelement foreachname=valuepairthatyouwantto submit,wherethekeyrepresentsthename portionofthepairandthevaluerepresentsthe valueportionofthepair. Notethatwhenyouuseargs,loadXMLNodewill automatically: URLencodename=valuepair,soyoudo notneedtoURLencodethevaluesyou specifyinargs. Insertthe&characterbetweenpairs,so youdonotneedtoincludeitinargs. Prefixtheentirequerystringwiththe? characterifitsubmitsthedatainargsviaa GET.Youdonotneedtoincludethis characterinargs. Whenyousubmitdatausingtheargsvariable, theIntegrationServerautomaticallysetsthe valueoftheContentTypeheaderto application/x-www-form-urlencoded.Ifyou wanttoexplicitlyspecifyadifferentContent Type,youmustsubmityourdatausingthe stringorbytesvariable.
662
37 XML Folder
table
String Table Optional.Specifiesdatathat loadXMLNodewillusetoconstructaquerystring tosubmittotheresourcespecifiedinurl. tableissimilartoargs,butitallowsyouto submitunnamedvaluesinaquerystring,not justname=valuepairs. Tospecifydatausingtable,createonerowfor eachvaluethatyouwanttosubmit,where: Thecontentsofcolumn0representthe nameportionofthepair(leavethiscolumn nulltosubmitanunnamedvalue,and Thecontentsofcolumn1representthe valueportionofthepair. Whenyousubmitdatausingthetablevariable, theIntegrationServerautomaticallysetsthe valueoftheContentTypeheaderto application/x-www-form-urlencoded.Ifyou wanttoexplicitlyspecifyadifferentContent Type,youmustsubmityourdatausingthe stringorbytesvariable. Notethatwhenyouusetable,loadXMLNodewill automatically: URLencodename=valuepair,soyoudo notneedtoURLencodethevaluesyou specifyintable. Insertthe&characterbetweenthepairs (orunnamedvalues)thatitconstructs,so youdonotneedtoincludeitintable. Prefixtheentirequerystringwiththe? characterifitsubmitsthedataintablevia theGETmethod.Youdonotneedto includethischaracterintable.
663
37 XML Folder
string
StringOptional.TextthatyouwantloadXMLNode tosubmittotheresourceinurl. Youcanusestringtosubmitdataviaeitherthe POSTorGETmethod. Ifyouusestringtospecifyyourdata,makesure thatyouspecifythestringexactlyasyouwantit presentedintheHTTPrequest.(Ifyouare usingtheGETmethod,makesureyouURL encodethecontentsofstring).When performingaPOSTthestringissubmittedto theresourceasthebodyofthedocument.
bytes
byte[ ]Optional.DatathatloadXMLNodeisto submittotheresourceinurl.Youcanusebytes onlytosubmitdataviathePOSTmethod. Note: Whenyouusebytesandanotherelement (args,table,orstring)tosubmitdatawith loadXMLNode,theserviceappendsthedatafrom theargs,table,orstringelementtourl.The serviceappendsargstourlfirst,tablesecond, andstringlast.Theserviceencodesthedata fromthebyteselementinthebodyofthepost.
stream
java.io.InputStreamOptional.Datathat loadXMLNodeistosubmittotheresourceinurl. Youcanusestreamonlytosubmitdataviathe POSTmethod. Note: Whenyouusestreamandanotherelement (args,table,orstring)tosubmitdatawith loadXMLNode,theserviceappendsthedatafrom theargs,table,orstringelementtourl.The serviceappendsargstourlfirst,tablesecond, andstringlast.Theserviceencodesthedata fromthestreamelementinthebodyofthepost. Ifstreamisspecified,bytesisignored.
encoding
StringOptional.NameofaregisteredIANA characterset.
664
37 XML Folder
headers
DocumentOptional.Fieldsthatyouwanttoexplicitlyoverrideinthe HTTPrequestheaderissuedbyloadXMLNode. Specifyoneelementforeachheaderfieldthatyouwanttoset, wheretheelementsnamerepresentsthenameoftheheaderfield, andtheelementsvaluerepresentsthevalueofthatheaderfield. Ifheadersisnotset,loadXMLNodewilluseitsdefaultheadervalues. StringOptional.Charactersetinwhichthereturneddocumentis encoded.Theparserrequiresthisvalueinordertointerpreta documentcorrectly. Set to...
autoDetect
encoding
To... Determinethedocumentscharactersetbased ondocumenttype,where: ISO88591isusedforHTML. UTF8isusedforXML.
Thenameofa registeredIANA characterset
Decodethedocumentusingthatcharacterset (forexample,ISO-8859-1).
Ifyoudonotspecifyanencodingvalue,loadXMLNodedecodesthe returneddocumentusingthefollowingdefaults: If the document is...

HTML XML
It is decoded using...
ISO-8859-1 UTF-8
expandDTD
StringOptional.FlagindicatingwhetherornotloadXMLNodeisto processreferencestoparameterentitiesinthereturneddocuments DTD. Set to...

true
To... Expandreferencestoparameterentitiestotheir fulldefinition. Default.Ignorereferencestoparameterentities.
false
665
37 XML Folder
isXML
StringOptional.Flagindicatingwhetherthereturneddocumentis XMLorHTML.loadXMLNodemustknowthisinordertoparsea documentcorrectly. Set to...

autoDetect
To... Default.Parsethedocumentbasedonitstype. Whenyouusethisoption,loadXMLNodesenses thedocumentstypebasedonits<!DOCTYPE> or<?XML>tag.Ifitcannotdeterminea documentstype,itparsesitasHTML. ParsethedocumentasXML. ParsethedocumentasHTML.
true false
loadAs
StringOptional.Flagthatspecifiestheforminwhichyouwant loadXMLNodetomaketheparseddocumentavailabletosubsequent services. Set to...

bytes
To... Default.Makethedocumentavailableasabyte array. Usethisoptionifthedocumentwillbeusedas inputtoaservicethatoperatesonwhole documents(forexample,pub.xml:queryXMLNode).
stream
Makethedocumentavailableasan InputStream. Usethisoptionifthedocumentwillbeusedas inputtoaservicethatcanprocessadocument incrementally(forexample, pub.xml:getXMLNodeIterator).
failOnHTTPErro r
StringOptional.DetermineswhetherloadXMLNodewillfail(throwan exception)iftherequestedURLisnotloadedcorrectlybasedonan HTTPstatuscode.Thisparameterallowsforcustomizederror handlingoftheloadfailure. Set to...

true
To... ThrowaserviceexceptioniftheURLisnot loadedasindicatedbyanHTTPstatuscode between400and599,inclusive. Default.IgnoreHTTPerrors.Ifthereisanerror, theHTMLpagereturnedbythewebserverwill besenttotheparser.
false
666
37 XML Folder
Output Parameters node Usage Notes IfloadXMLNodedoesnotreceivearesponsewithinthetimeoutperiodspecifiedinthe serverswatt.net.timeoutparameter,itwillthrowanexception.Forinformation aboutthewatt.net.timeoutparameter,seethewebMethodsIntegrationServer AdministratorsGuide. com.wm.lang.xml.NodeXMLnoderepresentingthereturnedHTMLor XMLdocument.
pub.xml:queryXMLNode
WmPublic.QueriesanXMLnode. Thefieldsparameterspecifieshowdataisextractedfromthenodetoproduceanoutput variable.Thisoutputvariableiscalledabinding,becausethefieldsparameterbindsa certainpartofthedocumenttoaparticularoutputvariable.Atruntime,thisservice mustincludeatleastonefieldsentry.Theservicemustincludeatleastoneentryinfields. Theresultofeachqueryyouspecifyinfieldsisreturnedinavariablewhosenameand typeyouspecify. Input Parameters node com.wm.lang.xml.NodeXMLnodethatyouwanttoquery.AnXML nodecanbeproducedbypub.xml:loadXMLNode, pub.xml:xmlStringToXMLNodeoranXMLcontenthandler. DocumentOptional.Namespacesassociatedwithanynamespace prefixesusedelementtospecifyelementsinfields/query.Eachentry innsDeclsrepresentsanamespaceprefix/URIpair,whereakey namerepresentsaprefixandthevalueofthekeyspecifiesthe namespaceURI.
GSX
nsDecls
Forexample,todefinetheURIsassociatedwithtwoprefixescalled andTxMon,youwouldsetnsDeclsasfollows:
fields
Document ListOptional.Parametersdescribinghowdataistobe extractedfromnode.Eachdocumentinthelistcontainsparameters forasinglequery,asfollows:
667
37 XML Folder
Key name resultType
Description StringNametoassigntoresultingvalue. StringObjecttypethatthequeryistoyield.The followingshowstheallowedvaluesforresultType. Becausethisparameteristypicallysetthroughthe VariablestabinDeveloper,thesettingyouwouldselect inDeveloperisalsoshownhere. Underlying Value

Object Object[] Record Record[] String String[] String[][]
Corresponding Selection in Developer Object ObjectList Document DocumentList String StringList StringTable
query queryType onnull
StringQueryidentifyingthedatatobeextractedfrom node. StringQuerylanguageinwhichqueryisexpressed. ValidvaluesareWQLandXQL. StringCodeindicatingwhatyouwantqueryXMLNode to dowhentheresultisnull.Settooneofthefollowing: Set to...

continue
To indicate that... Allresultvaluesareacceptableforthis query(includingnull). Theserviceshouldfailiftheresultof thisqueryisnullandcontinueinall othercases. Theserviceshouldcontinueiftheresult ofthisqueryisnullandfailinallother cases.
fail
succeed
fields
Document ListParametersthatsupportrecursive executionofbindings.Eachfieldslistdefinesbindings foroneleveloftheoutputwiththetoplevelbeingthe pipelineandthefirstleveldownbeingcontentsofa documentordocumentlistinthepipeline.
668
37 XML Folder
Output Parameters DocumentResultsfromthequeriesspecifiedinfields.Thisservicereturnsoneelementfor eachqueryspecifiedinfields.Thespecificnamesandtypesofthereturnedelementsare determinedbythefields/nameandfield/resultTypeparametersoftheindividualqueries.
pub.xml:xmlNodeToDocument
WmPublic.ConvertsanXMLnodetoadocument(anIDataobject). ThisservicetransformseachelementandattributeintheXMLnodetoanelementinan IDataobject.Forexample: This service would convert this XML document...
<?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>
To an IData that looks like this...
Notethat: TheXMLversionattributeisconvertedtoanelementnamed@version. TheresultingdocumentisgiventhesamenameastheXMLdocumentsrootelement (AcctInfointheexampleabove)andisachildofthedocumentvariablethatthis servicereturns. Simpleelements(suchas<name>and<rep>intheexampleabove)areconvertedto Stringelements. Complexelements(thatis,elementswithchildren,suchas<address>intheexample above)andsimpleelementsthathaveattributes(suchas<acctNum>and<phoneNum>) areconvertedtodocuments(IDataobjects).Notethatkeysderivedfromattributes areprefixedwitha@charactertodistinguishthemfromkeysderivedfrom elements.Alsonotethatwhenasimpleelementhasanattribute,itsvalueisplacedin anelementnamed*body.
669
37 XML Folder
Repeatedelements(suchas<serialNum>)canbecollectedintoarraysusingthe makeArraysand/orarraysparameters.SeemakeArraysandarraysbelowforadditional informationaboutproducingarrays. Input Parameters node attrPrefix com.wm.lang.xml.NodeXMLnodethatistobeconvertedtoa document(IDataobject). StringOptional.Prefixthatistobeusedtodesignatekeys containingattributevalues.Thedefaultis@.Forexample,if yousetattrPrefixtoATT_andnodecontainedthefollowing element:
<tx currency=dollars> <acct>cash</acct> <amt>120.00</amt> </tx>
xmlNodeToDocumentwouldconvertthecurrencyattributeas follows:
The currency attribute is prefixed with the characters ATT_
arrays
String ListOptional.Namesofelementsthataretobegenerated asarrays,regardlessofwhethertheyappearmultipletimesin node.Forexample,ifarrayscontainedthefollowingvaluesfor theXMLdocumentshownintheexampleinthedescriptionfor thisservice:

rep address
xmlNodeToDocumentwouldgenerateelementrepasaStringList andelementaddressasaDocumentList. Important! Ifyouincludenamespaceprefixesintheelement namesthatyouspecifyinarrays,youmustdefinethe namespacesassociatedwiththoseprefixesinnsDecls. makeArrays StringOptional.Flagindicatingwhetheryouwant xmlNodeToDocumenttoautomaticallycreateanarrayforevery elementthatappearsinnodemorethanonce. Set to...
true
To... Default.Automaticallycreatearraysforevery elementthatappearsmorethanonceinnode.
670
37 XML Folder
false
Createarraysforonlythoseelementsspecifiedin arraysordefinedasarraysinthedocumenttype specifiedindocumentTypeName. Important! YoumustsetmakeArraystofalsewhen usingdocumentTypeNametodefinethestructureofan element.Otherwise,anexceptionwillbethrownat runtime.
collect
DocumentOptional.Elementsthataretobeplacedintoanew, namedarray(thatis,acollection).Withincollect,usekey namestospecifythenamesoftheelementsthataretobe includedinthecollection.Thensetthevalueofeachkeyto specifythenameofthecollectioninwhichyouwantthat elementplaced.Forexample,ifyouwantedtoplacethe<name> and<rep>elementsinanarraycalledoriginator,youwouldset collectasfollows: Key name rep Value
originator originator
Ifthesetofelementsinacollectionareallsimpleelements,a StringListisproduced.However,ifthesetismadeupof complexelements,oracombinationofsimpleandcomplex elements,aDocumentListisproduced.Whenthisisthecase, eachmemberofthearraywillincludeachildelementcalled *namethatcontainsthenameoftheelementfromwhichthat memberwasderived. Youmayoptionallyincludenamespaceprefixesintheelement namesthatyouspecifyincollect;however,ifyoudo,youmust definethenamespacesassociatedwiththoseprefixesinnsDecls. Important! Youcannotincludeanelementinmorethanone collection.
671
37 XML Folder
nsDecls
DocumentOptional.Namespaceprefixestouseforthe conversion.Thisparameterspecifiestheprefixesthatwillbe usedwhennamespacequalifiedelementsareconvertedtokey namesintheresultingIDataobject.Forexample,ifyouwant elementsbelongingtoaparticularnamespacetohavetheprefix GSXintheresultingIData(forexample,GSX:acctNum),you wouldassociatetheprefixGSXwiththatnamespaceinnsDecls. (ThisisimportantbecauseincomingXMLdocumentscanuse anyprefixforagivennamespace,butthekeynamesexpected byatargetserviceorMAPstepontheIntegrationServerwill haveafixedprefix.) NamespaceprefixesinnsDeclsalsodefinetheprefixesusedby thearrays,documents,documentTypeName,andcollectparameters. EachentryinnsDeclsrepresentsanamespaceprefix/URIpair, whereakeynamerepresentsaprefixandthevalueofthekey specifiesthenamespaceURI. Forexample,todefinetheURIsassociatedwithtwoprefixes calledGSX andTxMon,youwouldsetnsDeclsasfollows:
672
37 XML Folder
documents
String ListOptional.Namesofanysimpleelementsthataretobe generatedasdocuments(IDataobjects)insteadofStrings.The documentproducedforeachelementspecifiedindocumentswill havethesamenameasthesourceelementfromwhichitis derived.ItwillcontainaStringelementnamed*bodythatholds theelementsvalue. Forexample,ifdocumentscontainedtheStringsnameandrepand thesourcedocumentcontainedthefollowing:

. . . <name>Midwest Extreme Sports</name> <rep>Laura M. Sanchez</rep> . . .
xmlNodeToDocumentwouldproducethefollowing:
Note: Ifyouincludenamespaceprefixesintheelementnames thatyouspecify,youmustdefinethenamespacesassociated withthoseprefixesinnsDecls.
673
37 XML Folder
documentTypeName
StringOptional.Fullyqualifiednameofthedocumenttypethat specifiesthestructurethatistobeimposedontheresulting document.Youcanusethisparametertoexplicitlyspecifythe orderanddimensionalityofelements.Itisanalternativeto usingmakeArraysandarraystospecifywhichelementsaretobe generatedasarrays. Forexample,ifyouhadtheXMLdocumentshowninthe exampleinthisservicesdescription,andyouwantedthe<name> and<rep>elementstobegeneratedasStringlists,youwould definethemasStringListsfieldsinadocumenttypeandthen specifythatdocumenttypeindocumentTypeName. Note: ThedocumenttypespecifiedindocumentTypeNamedoes notneedtospecifyeveryelementthatwillappearinthe resultingdocument.Itonlyneedstospecifytheelementswhose structureyouwanttoexplicitlyset.However,ifyouinclude namespaceprefixesintheelementnamesthatyouspecify,you mustdefinethenamespacesassociatedwiththoseprefixesin nsDecls. ThisservicealwaysconvertsXMLnodestoStringorDocument objectfields.Itdoesnotgenerateconstrainedobjects(for example,FloatsorIntegers),evenifthefieldsinthespecified documentaredefinedasconstrainedobjects. Important! WhenyouusedocumentTypeName,setmakeArraysto falseanddonotsetarraysanddocuments.Otherwise, xmlNodeToDocumentwillthrowanexceptionatruntime.
674
37 XML Folder
mixedModel
StringOptional.Flagspecifyinghowmixedcontentelements (elementscontainingbothtextvaluesandchildelements)areto beconverted.Thefollowingisanexampleofamixedcontent element:

<comment> This job is <status>pending</status>. Estimated completion date is <edc>Feb 14, 2000</edc>. </comment>
Set to...
true
To... Placetopleveltextinanelementnamed*body.This settingwouldproducethefollowingIDataforthe <comment>elementshownabove:
Important! WhenyousetmixedModeltotrue,you mustalsousedocumentTypeNametospecifya documenttypethatdescribesthestructureofthe IDatathatyouwantxmlNodeToDocumenttoproduce. Withinthedocumenttype,mixedcontentelements mustbedefinedasdocumentsthatincludeaString fieldnamed*body.

false
Omittopleveltextandincludeonlythechild elementsfrommixedcontentelements.Thissetting wouldproducethefollowingIDataforthe<comment> elementshownabove:
Output Parameters document Document Document (IData object) representation of the nodes and attributes in node.
Usage Notes FollowingareexamplesofXMLdocumentsandthedocuments(IDataobjects)that xmlNodeToDocumentwouldproduce.
675
37 XML Folder
XML Document
<myDoc> <e1>e1Value</e1> </myDoc> <?xml version="1.0" encoding="UTF-8" standalone="no"?> <myDoc> <e1>e1Value</e1> </myDoc>
Output from xmlNodeToDocument
<?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>
676
37 XML Folder
XML Document
<?xml version="1.0" encoding="UTF-8"?> <myDoc> <e1 e1Attr="attrValue1">e1Value1</e1> <e2>e2Value</e2> <e1 e1Attr="attrValue2">e1Value2</e1> </myDoc>
Output from xmlNodeToDocument
Note: Thisexampleassumes thatmakeArraysissettotrue. Notethate1wascreatedasa documentlist,whichholds both<e1>elementsfromthe XMLdocument.

<?xml version="1.0" encoding="UTF-8"?> <myDoc> <e1 e1Attr="attrValue1">e1Value1</e1> <e2>e2Value</e2> <e1 e1Attr="attrValue2">e1Value2</e1> </myDoc>
Note: Thisexampleassumes thatmakeArraysissettofalse. Notethatonlythelast<e1> elementinthesourceXML wasretainedintheresulting 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>
677
37 XML Folder
pub.xml:xmlStringToXMLNode
WmPublic.ConvertsanXMLdocument(representedasaString,byte[ ],orInputStream) toanXMLnode. AnXMLnodeisaspecialrepresentationofanXMLdocumentthatcanbeconsumedby theIntegrationServer.MostwebMethodsservicesthatoperateonXMLdocuments requireanXMLnodeasinput. Input Parameters xmldata $filedata $filestream StringOptional.StringcontainingtheXMLdocumenttoconvertto anXMLnode. byte[ ]Optional.byte[]containingtheXMLdocumenttoconvert toanXMLnode. java.io.InputStreamOptional.InputStreamcontainingtheXML documenttoconverttoanXMLnode. Note: Specifyonlyoneoftheprecedingparameters. encoding StringOptional.Characterencodinginwhichtextisrepresented. SpecifyUTF8forXMLfilesandISO88591forHTMLfiles.To havetheparserattempttodetectthetypeofencoding,specify autoDetect(thedefault,ifencodingisnotspecified). StringOptional.Flagindicatingwhetherreferencestoparameter entitiesintheXMLdocumentsDTDaretobeprocessed. Set to...
true
expandDTD
To... Expandreferencestoparameterentitiestotheirfull definition. Default.Ignorereferencestoparameterentities.
false
isXML
StringOptional.Flagspecifyingwhethertheinputdocumentis XMLorHTML.(xmlStringToXMLNodemustknowthissothatitcan parsethedocumentcorrectly.) Set to...

autoDetect
To... Default.Parsethedocumentbasedonitstype. Whenyouusethisoption,xmlStringToXMLNodedetects thedocumentstypebasedonits<!DOCTYPE>or <?XML>tag.Ifitcannotdetermineadocuments type,itparsesitasHTML. ParsethedocumentasXML. ParsethedocumentasHTML.
true false
678
37 XML Folder
Output Parameters node com.wm.lang.xml.NodeXMLnoderepresentationoftheXML documentinxmlData.Thisobjectcanbeusedasinputto webMethodsservicesthatconsumeXMLnodes.
679
37 XML Folder
680
38
XSLT Folder
YouusetheelementsintheXSLTfoldertotransformanXMLstreamintoabytearray, file,orXMLnode,andtomaintaintheXSLTstylesheetcache.
681
38 XSLT Folder

Thefollowingelementsareavailableinthisfolder: Element pub.xslt.Transformations:transformSerialXML Package and Description WmXSLT.UsesanXSLTstylesheetto transformanXMLstream,thenstoresthe transformedXMLinabytearray,file,orXML node. WmXSLT.ClearstheXSLTstylesheetcache. WmXSLT.Removesonestylesheetfromthe XSLTstylesheetcache.
pub.xslt.Cache:removeAllTemplates pub.xslt.Cache:removeTemplate
TheWmXSLTpackagealsocomeswithsampleservicesthatshowyouhowtousethe publicservices.
pub.xslt.Transformations:transformSerialXML
WmXSLT.UsesanXSLTstylesheettotransformanXMLstream,thenstoresthe transformedXMLinabytearray,file,orXMLnode. Tooptimizeperformance,theservicestorestheXSLTstylesheetinacachesothe stylesheetwillbeinstantlyavailabletotheserviceforlaterruns. Input Parameters stylesheetSystemId systemId filename StringURIfortheXSLTstylesheettouse. StringURLoftheXMLtotransform.Ifyouspecifythisparameter, donotspecifythefilename,bytes,orxmlStreamparameter. StringFullyqualifiednameofthefilethatcontainstheXMLto transform.Thefilemustbelocatedonthelocalmachine.Ifyou specifythisparameter,donotspecifythesystemId,bytes,or xmlStreamparameter. byte[] XMLtotransform.Ifyouspecifythisparameter,donot specifythesystemId,filename,orxmlStreamparameter. Input streamXMLtotransform.Ifyouspecifythisparameter,do notspecifythesystemId,filename,orbytesparameter. Document Optional.Name/valuepairstopasstothestylesheet. SeetheXSLTServicesDevelopersGuideforinstructionsonsetting upastylesheettoworkwiththisparameter.
bytes xmlStream xslParamInput
682
38 XSLT Folder
resultType
StringTellsDeveloperwhattotransformtheXMLinto.Mustbe oneofthesevalues: Set to...

bytes file
To... TransformstheXMLintoabytearray. TransformstheXMLintoafile.Ifyouspecifyfile,you mustalsospecifytheoutFileNameparameter. TransformstheXMLintoanXMLnode.
xmlNode
outFileName
StringFullyqualifiednameofthefileinwhichtostorethe transformedXML.Thefilemustbelocatedonthelocalmachine. UsethisparameteronlyifyouspecifiedfileontheresultType parameter.
Output Parameters bytes byte[]BytearraythatcontainsthetransformedXML.Theservice placesthebytearrayinthepipelinesothatsubsequentservices canuseit.Thisvalueispresentonlyifyouspecifiedbytesinthe resultTypeinputparameter. com.wm.lang.xml.NodeNodethatcontainsthetransformedXML. TheserviceplacestheXMLnodeinthepipelinesothat subsequentservicescanuseit.Thisvalueispresentonlyifyou specifiedxmlNodeintheresultTypeinputparameter. Document Documentthatcontainsname/valuepairsthatwere returnedbythestylesheet.Theserviceplacesthedocumentinthe pipelinesothatsubsequentservicescanuseit.Thisvalueis presentonlyifyouaddname/valuepairstoitwithinyour stylesheet. SeePassName/ValuePairsfromtheStylesheettothePipeline onpage 20forinstructionsonsettingupyourstylesheettowork withthisparameter. Example YouwanttotransformanXMLdocumentnamedcdCatalog.xmlintoanHTML documentusinganXSLTstylesheetnamedcdCatalog.xsl.Youwouldpassthe transformSerialXMLservicethesevalues:
Input Parameters
node
xslParamOutput
stylesheetSystemId systemId resultType
http://localhost:5555/WmXSLT/samples/xdocs/cdCatalog.xsl http://localhost:5555/WmXSLT/samples/xdocs/cdCatalog.xml bytes
683
38 XSLT Folder
TheservicetransformstheXMLstreamintoabytearraycontaininganHTML documentandputsthebytearrayinthepipeline.Youcouldconvertthebytearray intoaStringusingtheIntegrationServerbuiltinservicepub.string:bytesToString,then displaytheStringusingadynamicserverpage(DSP).Forinformationonusing DSPs,seeDynamic Server Pages and Output Templates Developers Guide.
pub.xslt.Cache:removeAllTemplates
WmXSLT.ClearstheXSLTstylesheetcache. Input Parameters None. Output Parameters message StringIndicateswhethertheservicewasabletoclearthecache.
pub.xslt.Cache:removeTemplate
WmXSLT.RemovesonestylesheetfromtheXSLTstylesheetcache. Input Parameters stylesheetSystemId Output Parameters message StringIndicateswhethertheservicewasabletoremovethe stylesheetfromthecache. StringURIfortheXSLTstylesheettoremovefromthecache.
684
Index
A
access permissions assigned to built-in services 21 accessPoint 575 ACLs assigned to built-in services 21 activatePackage 324 add_publisherAssertions 622 addBodyEntry 468 addBodyPart 303 addComplexTask 394 addFloatList 289 addFloats 290 addHeaderEntry 469 adding body parts to MIME messages 303 documents to list 284 entries into a data store 493 LDAP server entries 272 MIME message headers 307 numeric values 289, 290, 291 strings to list 285 addIntList 290 addInts 291 addMimeHeader 307 addObjects 291 addOnetimeTask 397 addReleaseRegistryEntry 379 addRepeatingTask 400 address 577 addressLine 577 addSubscriber 150 addTrailer 472 alarm specification 153 alarmInfo document type 153 appending data to a remote file 55 appendToDocumentList 284 appendToStringList 285 arithmetic services 287 ART services 23 assertionStatusItem 578 assertionStatusReport 578 Assets services 45 asynchronous call to a remote server 376 asynchronous request/reply delivering request 347 description of 348, 361 publishing request 359 publishing request to a specific client 347 retrieving reply 364 attributes definition 275 modifying in LDAP entries 281 audit specification 154 auditInfo document type 155 authToken 579
B
base64Decode 507 base64Encode 507 binding entry into an LDAP server 272 listing 277 output template to Values object 390 bindingDetail 580 bindingKey 580 bindingTemplate 581 bindingTemplates 581 businessDetail 581 businessDetailExt 582 businessEntity 583 businessEntityExt 583 businessInfo 584 businessInfos 584 businessKey 584 businessList 584 businessService 585 businessServices 585 byte array from string 516 byte[ ], converting to InputStream 207 bytesToString 508
C
call 115 calling stored procedures 115 callStackItem document type 156 cancelTask 403 canonical document, definition 529
685
Index
canonical keys creating 528 inserting 532 retrieving 530 categoryBag 586 cd 56 cdls 56, 69 certificate chain 431 certs-only S/MIME Message creating 446 extracting certificates from 451 changing the working directory 56 character sequence, indexing first occurrence 510 clearing transactional state 118 clearKeyAndChain 431 clearPipeline 193 clearTransaction 118 client services 49 close connection 119 closeAll 120 closeLatch 526 closeStore 494 closing database connection 119 cluster services 101 committing changes to a database 120 commitTransaction 41 complex tasks adding to scheduler 394 updating to scheduler 410 concatenating array of strings 512 strings 508 connecting to an LDAP server 273 connections closing 274 creating 121 contacts 586, 587 content type, getting from MIME message 314 conventions used in this document 21 converting date formats 103 string list to document list 286 time formats 103 XML nodes to IData objects 669 createCertsOnlyData 446 createEncryptedData 447 createMessageDigest 440 createMimeData 308
createSignedAndEncryptedData 335, 448 createSignedData 336, 449 createSoapData 473 createXReference 528 createXSD 422 creating MIME messages 308 cross-references creating 528 deleting by object ID 529 deleting individual records 530 inserting 532 current VCS user removing 645 setting 646
D
data converting 207 waiting for delivery 522 data stores adding entries 493 closing 494 deleting 494 inserting entries 500 registering 500 removing entries 502 retrieving values 495 unlocking entries 500, 502 unregistering 494 updating entries 500 database connection, closing 119, 120 database services 113 databases clearing transactional state 118 closing connections 119, 120 committing changes 120 creating connections 121 deleting rows 123 discarding changes 137 invoking stored procedures 115 querying 135 retrieving names of stored procedures 129 retrieving tables 132 starting a transaction 138 datatypes in XML Schemas 427 date/time transformation services 103 dateBuild 108
686
Index
dates converting formats 110 formatting 111 invalid dates 107 returning current 112 symbols used for 104 time zones 105 dateTimeBuild 109 dateTimeFormat 110 debug log 193 debugging services 191 decoding URL-encoded strings 518 decrypting MIME messages 451 S/MIME messages 337 default key, associating with invoked services 431 delete_binding 622 delete_business 623 delete_publisherAssertions 624 delete_service 625 delete_tModel 625 deleteByObjectId 529 deleteReleaseRegistryEntry 380 deleteStore 494 deleteSubscriber 156 deleteXReference 530 deleting cross-reference by object ID 529 cross-references 530 data stores 494 entry from an LDAP server 274 files in working directory 57 rows from a database 123 subscribers from subscription list 156 deliver service 345 deliverAndWait service 346 digital signatures attaching to MIME messages 449 verifying 338, 438, 453 dir 58 directory changing 56 looking up entries on LDAP server 278 searching for entries 280 disableConnection 26 disableListener 29 disableListenerNotification 33
disablePackage 325 disablePollingNotification 34 discard_authToken 626 disconnecting from an LDAP server 274 discoveryURL 587 discoveryURLs 587 dispositionReport 588 distributeViaFTP 381 distributeViaSvcPull 381 distributeViaSvcPush 382 divideFloats 292 divideInts 293 divideObjects 293 docType_categoryBag 588 docType_description 589 docType_keyedReference 589 docType_name 589 document processing resuming 550 suspending 558 document resolver spec, for JMS messages 220 document retrieval resuming 553 suspending 561 document services 141 document types alarmInfo 153 audit event information 155 callStackItem 156 exception information 158 gdEndInfo 160 gdStartInfo 161 portStatusInfo 171 QName 481 replicationInfo 173 sessionEndInfo 177 sessionExpireInfo 178 sessionStartInfo 180 statInfo 182 txEndInfo 183 txStartInfo 184 documentation additional 22 conventions used 21 feedback 22 documentListToDocument 142 documentResolverSpec specification 349
687
Index
documents adding to list 284 constructing from a list of documents 142 converting list from string list 286 converting to a String 145 converting to XML strings 650 delivering 345 delivering and waiting for reply 346 expanding contents into a list of documents 144 publishing 356 publishing and waiting for reply 358 replying to 362 resolving status of 349 retrieving redelivery count 355 waiting for 364 documentToDocumentList 144 documentToXMLString 650 documentToXMLValues 145 dynamic text generation 390
E
elements, number of in a list 285 email 589 enableConnection 26 enableListener 30 enableListenerNotification 34 enablePackage 326 enablePollingNotification 34 encoding schema, SOAP 468 encoding URL strings 519 encrypting MIME messages 335, 447 ending guaranteed delivery transactions 372 entries adding to LDAP server 272 inserting into repository 493 looking up on LDAP server 278 searching for all matching 280 envelope schema, SOAP 468 envelope stream, generating from MIME message 315 envelope, for published documents 351 errInfo 590 error notification document type 366 error service 366 event handlers 147 alarm specification 153 alarmInfo document type 153 audit specification 154
auditInfo document type 155 callStackItem document type 156 exception specification 157 exceptionInfo document type 158 gdEnd specification 159 gdEndInfo document type 160 gdStart specification 160 gdStartInfo document type 161 get list of event types 162 get list of subscribers 163 modify subscriber info 167 portStatus specification 171 portStatusInfo document type 171 reload event manager settings 172 replication specification 172 replicationInfo document type 173 save event manager settings 173 sessionEnd specification 177 sessionEndInfo document type 177 sessionExpire specification 178 sessionExpireInfo document type 178 sessionStart specification 179 sessionStartInfo document type 180 stat specification 180 statInfo document type 182 subscriptions for 150 txEnd specification 183 txEndInfo document type 183 txStart specification 184 txStartInfo document type 184 unsubscribing from an event 156 events, creating subscriptions for 150 exception specification 157 exceptionInfo document type 158 exceptions for retry 201 exceptions, last trapped in a flow 194 execSQL 124 exitUnableToUnderstand 474 extensions files with no extension, using with FTP put command 69 extracting MIME content 311 extracting MIME message headers 313, 317
F
fields, removing from pipeline 193 file object, templates 388 file services 187
688
Index
files appending data to 55 deleting 57 listing 56, 58, 64, 69 multiple delete 65 multiple get 66 multiple transfer 67 renaming 70 retrieving 58, 188 saving pipeline contents 199 transferring 68 find_binding 602 find_business 603 find_businessByCategory 604 find_businessByDiscURLs 605 find_businessByIdentity 606 find_businessByName 606 find_businessBytModel 607 find_relatedBusinesses 608 find_service 609 find_serviceByBusKey 610 find_serviceByCategory 611 find_serviceByName 612 find_serviceBytModel 613 find_tModel 614 find_tModelByCategory 615 find_tModelByIdentity 616 find_tModelByName 617 finding universal names 638 findQualifier 590 findQualifiers 590 fire-and-forget call 374 floating point numbers adding 289 dividing 292 multiplying 294 subtracting 298 flow services 191 forcing a response string 200 formatDate 111 formatting array of strings 512 number to numeric pattern 513 freeXMLNode 657 fromKey 590 FTP changing directory and listing files 56, 69 changing working directory 56
client actions 52 delete file 57 executing non-standard FTP commands 70 file transfer 68 files with no extension 69 ftp_no_extension key 69 listing files 58, 64 login 61 logout 64 multiple file delete 65 multiple file get 66 multiple file transfer 67 renaming files 70 retrieving files 58 session info 71 transferring files 68 FTP servers, submitting requests to 49, 72
G
gdEnd specification 159 gdEndInfo document type 160 gdStart specification 160 gdStartInfo document type 161 generateReplicationEvent 382 get (FTP) files 58 get_assertionstatusReport 627 get_authToken 628 get_bindingDetail 618 get_businessDetail 618 get_businessDetailExt 619 get_publisherAssertions 629 get_registeredInfo 630 get_serviceDetail 620 get_tModelDetail 621 getActor 474 getAttributeDef 275 getBody 475 getBodyEntries 476 getBodyPartContent 311 getBodyPartHeader 313 getCanonicalKey 530 getCertificateInfo 440 getClassDef 276 getClusterHosts 102 getConnectionStatistics 27 getContentType 314 getCurrentDate 112 getCurrentDateString 112
689
Index
getDocument 476 getEnvelopeStream 315 getEventTypes 162 getFile 188 getHeader 477 getHeaderEntries 478 getLastError 194 getLocalReleasedList 382 getMimeHeader 317 getMustUnderstand 479 getNativeId 531 getNextXMLNode 657 getNumParts 318 getPrimaryContentType 319 getProcInfo 128 getProcs 129 getQName 480 getRedeliveryCount service 355 getRemoteReleasedList 383 getSession 196 getStatus 372 getSubContentType 319 getSubscribers 163 getTableInfo 130 getTables 132 getTaskIDs 403 getTaskInfo 404 getTrailer service 481 getTransportInfo 196 getUsers 644 getXMLNodeIterator 658 getXMLNodeType 660 guaranteed delivery services 369 guaranteed delivery transactions ending 372 getting status of 372 invoking service 373 restarting 373 retrieving results of 374 starting 375 guaranteed one-way call 374
HTTP changing header variables 72 response code 201 submitting requests to servers 49, 72
I
IData objects, converting to XML strings 650 identifierBag 591 IDs, retrieving list of 403 indexOf 510 InputStream, converting to byte 207 inserting table rows 134 insertXReference 532 installPackage 327 instanceDetails 591 instanceParms 591 integers adding 290 dividing 293 multiplying 296 subtracting 299 invalid dates 107 invoke, guaranteed delivery service 373 invoking client services 49 remote services 369 report services 387 stored procedures 115 invoking a service guaranteed delivery 376 protocols used 203 remote webMethods Integration Server 370 IO services 207 isLatchClosed 527 iterating through XML nodes 658
J
JDBC-related services 113
K
key string lookup 510, 511 keyedReference 592 keys, obtaining a list in a data store 496 keysOwned 592
H
header fields, adding to MIME object 307 headers, changing HTTP 72 hostingRedirector 590 HTMLDecode 508 HTMLEncode 509
690
Index
L
latch operations checking latch status 527 closing 526 opening 528 LDAP server adding entries 272 closing connections 274 connecting to 273 deleting entries 274 listing bindings 277 looking up an entry 278 retrieving attribute definitions 275 retrieving objectclass definitions 276 searching for entries 280 updating attributes for an entry 281 LDAP services 271 length of a string 510 list adding, retrieving, or replacing elements 283 LDAP 277 number of elements 285 registered consumer handlers 460 registered processors 463 registered provider handlers 461 universal names 638 list services 283 listAdapterConnections 28 listAdapterListenerNotifications 35 listAdapterListeners 30 listAdapterPollingNotifications 36 listAdapterServices 40 listRegisteredAdapters 26 load balancing, enabling and disabling 101 loadPKCS7CertChain 441 loadXMLNode 661 locking a repository entry 497, 498, 501 log off of FTP server 64 logging pipeline fields 202 login to FTP server 61 lookup entry in an LDAP server 278 lookupDictionary 510 lookupTable 511 lowercase, converting to 517 ls 64
M
makeString 512 math services 287 mdelete 65 mergeHeaderAndBody 320 messageFormat 512 mget 66 MIME messages adding body parts to 303 adding headers to 307 creating 308 creating encrypted messages 447 creating signed messages 449 decrypting 451 discovering content type 314 discovering number of parts 318 discovering subtype 319 generating message stream 315 getting content from 311 getting headers from 317 getting part headers from 313 getting top-level portion 319 merging HTTP response into InputStream 320 sending through SMTP 87 signing and encrypting 335, 448 verifying signed messages 453 MIME services 301 modifySubscriber 167 mput 67 multiple VCS users removing 645 setting 647 multiplyFloatList 294 multiplyFloats 295 multiplyIntList 296 multiplyInts 296 multiplyObjects 297
N
namespace components 428 native ID, retrieving 531 node iterator creating 658 freeXMLNode 657 getNextXMLNode 657 getXMLNodeIterator 658 notification error document type 366 notifying services 522
691
Index
notifyPackageRelease 384 numeric values adding 289, 290, 291 dividing 293 multiplying 294, 295, 296, 297 subtracting 298, 299 numericFormat 513
O
objectclass definitions 276 objects adding 291 dividing 293 multiplying 297 subtracting 299 one-time tasks adding to scheduler 397 updating to scheduler 414 one-way call, guaranteed 374 openLatch 528 outbound passwords 429 creating a WmSecureString 441 internal vs. public 434 listing keys 436 removing 436 retrieving 435 setting 433 updating 437 output templates 387 overviewDoc 592
P
package management services 323 Package Release Registry adding entries 379 deleting entries 380 obtaining local server list 382 package replication services 377 packageCreation 384 packages activating 324 disabling 325 enabling 326 installing 327 recovering 328 reloading 329 padLeft 514 padRight 515
pattern strings, date patterns 104 phone 592 pipeline applying templates to 389 inserting Session object 196 removing fields 193 restoring previously saved 197 saving contents to a file 199 saving into memory 199 tracing 202 using previously saved keys and values 198 validating against a document type 426 pipeline services 191 PKCS7 signatures 331 PKCS7 SignedData objects 332 creating 437 PKI profiles 331 portStatus specification 171 portStatusInfo document type 171 processCertsOnlyData 451 processEncryptedData 337, 451 processing resuming for triggers 550 suspending for triggers 558 processMessage 464 processRPCMessage 465 processSignedData 338, 453 program code conventions in this document 21 protocols, retrieving information about 196, 203 pseudorandom number generator 298 pub.art listRegisteredAdapters 26 pub.art.connection disableConnection 26 enableConnection 26 getConnectionStatistics 27 queryConnectionState 29 pub.art.listener disableListener 29 enableListener 30 queryListenerState 31 setListenerNodeConnection 32 pub.art.notification disableListenerNotification 33 disablePollingNotification 34 enableListenerNotification 34 enablePollingNotification 34 listAdapterPollingNotifications 36
692
Index
queryListenerNotificationState 37 queryPollingNotificationState 37 resumePollingNotification 38 setListenerNotificationNodeListener 39 setPollingNotificationNodeConnection 39 suspendPollingNotification 40 pub.art.service listAdapterServices 40 setAdapterServiceNodeConnection 41 pub.art.transaction commitTransaction 41 rollbackTransaction 42 setTransactionTimeout 43 startTransaction 44 pub.asset publish 46 pub.client ftp 52, 53 http 72 smtp 87 soapClient 89 soapHTTP 93 soapRPC 97 pub.client.ftp append 55 cd 56 cdls 56 delete 57 dir 58 get 58 login 61 logout 64 ls 64 mdelete 65 mget 66 mput 67 put 68 putCompletedNotification 69 quote 70 rename 70 sessioninfo 71 pub.cluster getClusterHosts 102 pub.date dateBuild 108 dateTimeBuild 109 dateTimeFormat 110 formatDate 111
getCurrentDate 112 getCurrentDateString 112 pub.db call 115 clearTransaction 118 close 119 closeAll 120 commit 120 connect 121 delete 123 execSQL 124 getProcInfo 128 getProcs 129 getTableInfo 130 getTables 132 insert 134 query 135 rollback 137 startTransaction 138 update 139 pub.document documentListToDocument 142 documentToDocumentList 144 documentToXMLValues 145 XMLValuesToDocument 145 pub.event addSubscriber 150 alarm 153 alarmInfo 153 audit 154 auditInfo 155 callStackItem 156 deleteSubscriber 156 exception 157 exceptionInfo 158 gdEnd 159 gdEndInfo 160 gdStart 160 gdStartInfo 161 getEventTypes 162 getSubscribers 163 modifySubscriber 167 portStatus 171 portStatusInfo 171 reloadEventManagerSettings 172 replication 172 replicationInfo 173 saveEventManagerSettings 173
693
Index
security 174 securityInfo 175 sessionEnd 177 sessionEndInfo 177 sessionExpire 178 sessionExpireInfo 178 sessionStart 179 sessionStartInfo 180 stat 180 statInfo 182 txEnd 183 txEndInfo 183 txStart 184 txStartInfo 184 pub.file getFile 188 pub.flow clearPipeline 193 debugLog 193 getLastError 194 getRetryCount 195 getSession 196 getTransportInfo 196 restorePipeline 197 restorePipelineFromFile 198 savePipeline 199 savePipelineToFile 199 setResponse 200 setResponseCode 201 throwExceptionForRetry 201 tracePipeline 202 transportInfo 203 pub.io close 209 createByteArray 209 mark 210 markSupported 210 read 211 reset 211 skip 212 streamToBytes 212 pub.jms documentResolverSpec 220 pub.ldap bind 272 connect 273 delete 274 disconnect 274
getAttributeDef 275 getClassDef 276 list 277 lookup 278 search 280 update 281 pub.list appendToDocumentList 284 appendToStringList 285 sizeOfList 285 stringListToDocumentList 286 pub.math addFloatList 289 addFloats 290 addIntList 290 addInts 291 addObjects 291 divideFloats 292 divideInts 293 divideObjects 293 multiplyFloatList 294 multiplyFloats 295 multiplyIntList 296 multiplyInts 296 multiplyObjects 297 randomDouble 298 subtractFloats 298 subtractInts 299 subtractObjects 299 pub.mime addBodyPart 303 addMimeHeader 307 createMimeData 308 getBodyPartContent 311 getBodyPartHeader 313 getContentType 314 getEnvelopeStream 315 getMimeHeader 317 getNumParts 318 getPrimaryContentType 319 getSubContentType 319 mergeHeaderAndBody 320 pub.packages activatePackage 324 disablePackage 325 enablePackage 326 installPackage 327
694
Index
recoverPackage 328 reloadPackage 329 pub.pki.pkcs7 sign 332 verify 333 pub.pki.smime createSignedAndEncryptedData 335 createSignedData 336 processEncryptedData 337 processSignedData 338 pub.publish deliver 345 deliverAndWait 346 documentResolverSpec 349 envelope 351 getRedeliveryCount 355 publish 356 publishAndWait 358 reply 362 waitForReply 364 pub.publish.notification error 366 pub.remote invoke 370 pub.remote.gd end 372 getStatus 372 invoke 373 restart 373 retrieve 374 send 374 start 375 submit 376 pub.replicator addReleaseRegistryEntry 379 deleteReleaseRegistryEntry 380 distributeViaFTP 381 distributeViaSvcPull 381 distributeViaSvcPush 382 generateReplicationEvent 382 getLocalReleasedList 382 getRemoteReleasedList 383 notifyPackageRelease 384 packageCreation 384 pub.report runFileTemplate 388 runFileTemplateOnPipe 389 runStringTemplate 389
runStringTemplateOnPipe 389 runTemplate 390 runTemplateOnPipe 391 pub.scheduler addComplexTask 394 addOnetimeTask 397 addRepeatingTask 400 cancelTask 403 getTaskIDs 403 getTaskInfo 404 resumeTask 409 suspendTask 410 updateComplexTask 410 updateOneTimeTask 414 updateRepeatingTask 416 pub.schema createXSD 422 validate 425 validatePipeline 426 pub.schema.w3c datatypes 427 xml 428 xsi 428 pub.security clearKeyAndChain 431 setKeyAndChain 432 setKeyAndChainFromBytes 433 pub.security.outboundPasswords listKeys 436 removePassword 436 setPassword 433 updatePassword 437 pub.security.pkcs7 sign 437 verify 438 pub.security.util convertSecureString 442 createMessageDigest 440 createSecureString 441 destroySecureString 443 getCertificateInfo 440 loadPKCS7CertChain 441 pub.smime createCertsOnlyData 446 createEncryptedData 447 createSignedAndEncryptedData 448 createSignedData 449 processCertsOnlyData 451
695
Index
processEncryptedData 451 processSignedData 453 pub.soap.handler listConsumer 460 listProvider 461 registerConsumer 462 registerProvider 462 unregisterConsumer 462 unregisterProvider 463 pub.soap.processor list 463 processMessage 464 processRPCMessage 465 registerProcessor 466 unregisterProcessor 467 pub.soap.schema encoding 468 envelope 468 pub.soap.utils addBodyEntry 468 addHeaderEntry 469 addTrailer 472 createSoapData 473 exitUnableToUnderstand 474 getActor 474 getBody 475 getBodyEntries 476 getDocument 476 getHeader 477 getHeaderEntries 478 getMustUnderstand 479 getQName 480 getTrailer 481 QName 481 removeBodyEntry 482 removeHeaderEntry 483 removeTrailer 484 requestResponseSpec 485 soapDataToString 487 streamToSoapData 487 stringToSoapData 488 validateSoapData 489 pub.storage add 493 closeStore 494 deleteStore 494 get 495
keys 496 listLocks 497 lock 498 put 500 registerStore 500 releaseLocks 501 remove 502 unlock 502 pub.string base64Decode 507 base64Encode 507 bytesToString 508 concat 508 HTMLDecode 508 HTMLEncode 509 indexOf 510 length 510 lookupDictionary 510 lookupTable 511 makeString 512 messageFormat 512 numericFormat 513 padLeft 514 padRight 515 replace 515 stringToBytes 516 substring 516 tokenize 518 toLower 517 toUpper 517 trim 518 URLDecode 518 URLEncode 519 pub.sync notify 522 wait 522 pub.synchronization.latch closeLatch 526 isLatchClosed 527 openLatch 528 pub.synchronization.xref createXReference 528 deleteByObjectId 529 deleteXReference 530 getCanonicalKey 530 getNativeId 531 insertXReference 532
696
Index
pub.trigger resumeProcessing 550 resumeRetrieval 553 suspendProcessing 558 suspendRetrieval 561 pub.uddi.client.doc accessPoint 575 address 577 addressLine 577 assertionStatusItem 578 assertionStatusReport 578 authToken 579 bindingDetail 580 bindingKey 580 bindingTemplate 581 bindingTemplates 581 businessDetail 581 businessDetailExt 582 businessEntity 583 businessEntityExt 583 businessInfo 584 businessInfos 584 businessKey 584 businessList 584 businessService 585 businessServices 585 categoryBag 586 contact 586 contacts 587 discoveryURL 587 discoveryURLs 587 dispositionReport 588 docType_categoryBag 588 docType_description 589 docType_keyedReference 589 docType_name 589 email 589 errInfo 590 findQualifier 590 findQualifiers 590 fromKey 590 hostingRedirector 590 identifierBag 591 instanceDetails 591 instanceParms 591 keyedReference 592 keysOwned 592 overviewDoc 592
phone 592 publisherAssertion 593 publisherAssertions 593 registeredInfo 594 relatedBusinessesList 595 relatedBusinessInfo 594 relatedBusinessInfos 595 result 595 schema_uddiv2 596 serviceDetail 596 serviceInfo 597 serviceInfos 597 serviceKey 597 serviceList 597 sharedRelationships 598 SOAPFault 598 tModelBag 599 tModelDetail 599 tModelInfo 600 tModelInfos 600 tModelInstanceDetails 600 tModelInstanceInfo 601 tModelKey 601 tModell 598 tModelList 601 toKey 602 uploadRegister 602 pub.uddi.client.inquiry find_binding 602 find_business 603 find_businessByCategory 604 find_businessByDiscURLs 605 find_businessByIdentity 606 find_businessByName 606 find_businessBytModel 607 find_relatedBusinesses 608 find_service 609 find_serviceByBusKey 610 find_serviceByCategory 611 find_serviceByName 612 find_serviceBytModel 613 find_tModel 614 find_tModelByCategory 615 find_tModelByIdentity 616 find_tModelByName 617 get_bindingDetail 618 get_businessDetail 618 get_businessDetailExt 619
697
Index
get_serviceDetail 620 get_tModelDetail 621 pub.uddi.client.publish add_publisherAssertions 622 delete_binding 622 delete_business 623 delete_publisherAssertions 624 delete_service 625 delete_tModel 625 discard_authToken 626 get_assertionstatusReport 627 get_authToken 628 get_publisherAssertions 629 get_registeredInfo 630 save_binding 631 save_business 632 save_service 633 save_tModel 634 set_publisherAssertions 634 pub.universalName find 638 list 638 pub.utils getServerProperty retrieves value of a server property 642 pub.vcs getUsers 644 removeCurrentUser 645 removeMultipleUsers 645 setCurrentUser 646 setMultipleUsers 647 pub.xml documentToXMLString 650 freeXMLNode 657 getNextXMLNode 657 getXMLNodeIterator 658 getXMLNodeType 660 loadXMLNode 661 queryXMLNode 667 xmlNodeToDocument 669 xmlStringToXMLNode 678 pub.xslt.Transformations transformSerialXML 682 publish 46 publish service 356 publish/subscribe, latching and cross-referencing operations 525 publishAndWait service 358
publisherAssertion 593 publisherAssertions 593 publishing packages 377 addReleaseRegistryEntry 379 deleteReleaseRegistryEntry 380 distributeViaFTP 381 distributeViaSvcPull 381 distributeViaSvcPush 382 generateReplicationEvent 382 getLocalReleasedList 382 getRemoteReleasedList 383 notifyPackageRelease 384 packageCreation 384 put (FTP) files 68
Q
QName document type 481 queryConnectionState 29 querying a database 135 queryListenerNotificationState 37 queryListenerState 31 queryPollingNotificationState 37 queryXMLNode 667 quote 70
R
random number generator 298 randomDouble 298 raw offset for time zones 105 records, deleting particular type 529 recoverPackage 328 recurring tasks, adding to scheduler 400 redelivery count, retrieving for documents 355 registeredInfo 594 registering consumer handlers 462 provider handlers 462 unregistering consumer handlers 462 unregistering provider handlers 463 registering data stores 500 registerProcessor 466 registerStore 500 relatedBusinessesList 595 relatedBusinessInfo 594 relatedBusinessInfos 595 release registry. See Package Release Registry reloadEventManagerSettings 172 reloadPackage 329
698
Index
remote file, appending data to 55 remote procedure call, submitting 97 remote servers, invoking services on 369, 370 removeBodyEntry 482 removeCurrentUser 645 removeHeaderEntry 483 removeMultipleUsers 645 removeTrailer 484 removing entries from data stores 502 renaming files on an FTP server 70 repeating tasks, updating to scheduler 416 replacing strings 515 replication specification 172 replicationInfo document type 173 replicator services 377 reply documents for join conditions 363 retrieving for asynchronous request 364 sending 362 volatile storage 362 reply service 362 report services 387 repository closing data store 494 creating/opening 500 deleting data store 494 inserting entries 493 inserting/updating entries 500 list of keys in 496 locking entries 497, 498, 501 locking entries in 497, 498, 501 registering 500 removing entries 502 retrieving keys from 496 retrieving values from 495 unlocking entries 502 request/reply model deliverAndWait service 348 delivering a request 346 multiple reply documents 361 publishAndWait service 360 publishing request 358 publishing request to a specific client 346 retrieving reply 364 sending replies 362 waitForReply service 364 waiting for reply 347, 359 requestResponseSpec 485
response string, forcing 200 restarting a guaranteed delivery transaction 373 restorePipeline 197 restorePipelineFromFile 198 result 595 resumeListener 32 resumePollingNotification 38 resumeTask 409 resuming document processing for triggers 550 document retrieval for triggers 553 retrieval resuming for triggers 553 suspending for triggers 561 retrieving documents from a local file system 187 files from FTP server 58 MIME content 311 MIME message headers 313, 317 results of guaranteed delivery transaction 374 retrieving reply 364 retry count, retrieving 195 retry exception 201 rollback 137 rollbackTransaction 42 RPC, submitting 97 runFileTemplate 388 runFileTemplateOnPipe 389 runStringTemplate 389 runStringTemplateOnPipe 389 runTemplate 390 runTemplateOnPipe 391
S
S/MIME messages creating certs-only message 446 creating encrypted messages 447 creating signed messages 449 creating using PKI profiles 331 decrypting 337, 451 extracting certificates from certs-only message 451 verifying signed messages 338, 453 S/MIME services 445 save_binding 631 save_business 632 save_service 633 save_tModel 634
699
Index
saveEventManagerSettings 173 savePipeline 199 savePipelineToFile 199 scheduler adding complex tasks 394 adding one-time tasks 397 canceling tasks 403 recurring tasks 400 resuming tasks 409 retrieving list of task IDs 403 retrieving task info 404 suspending tasks 410 updating complex tasks 410 updating one-time tasks 414 updating repeating tasks 416 scheduler services 393 schema services 421 schema_uddiv2 596 schemas attribute definition 275 creating 422 for validating 425 namespace components 428 objectclass definitions 276 retrieving tables 132 SOAP encoding schema 468 SOAP envelope schema 468 XML datatypes 427 searching an LDAP directory for entries 280 sending a guaranteed call 374 sending STOR or STOU commands to remove server 53, 67, 68 server log pipeline field names and values 202 writing to 193 servers, cluster listing 102 serviceDetail 596 serviceInfo 597 serviceInfos 597 serviceKey 597 serviceList 597 services default access permissions 21 listing of 19 Session object, inserting in pipeline 196 sessionEnd specification 177 sessionEndInfo document type 177 sessionExpire specification 178
sessionExpireInfo document type 178 sessioninfo 71 sessionStart specification 179 sessionStartInfo document type 180 set_publisherAssertions 634 setAdapterServiceNodeConnection 41 setCurrentUser 646 setKeyAndChain 432, 433 setListenerNodeConnection 32 setListenerNotificationNodeListener 39 setMultipleUsers 647 setPollingNotificationNodeConnection 39 setResponse 200 setResponseCode 201 setTransactionTimeout 43 sharedRelationships 598 signed data object, creating 437 SignedData objects 332 signing and encrypting MIME messages 335 signing MIME messages 336, 449, 453 sizeOfList 285 SMTP servers, submitting requests to 49, 72 SMTP, sending MIME messages 87 SOAP actor attribute 474 adding body entries 468 adding header entries 469 converting SOAP object to String 487 converting stream to SOAP object 487 converting string to SOAP object 488 creating SOAP objects 473 encoding schema 468 envelope schema 468 executing the default processor 464 executing the default RPC processor 465 getting body entries 475, 476, 481 getting entire message 476 getting header entries 477, 478 getting QNames 480 listing handlers, consumer 460 listing handlers, provider 461 listing processors 463 mustUnderstand attribute 474, 479 registering a processor 466 registering handlers, consumer 462 registering handlers, provider 462 removing body entries 482 removing header entries 483
700
Index
removing trailers 484 sending a SOAP message 93 sending a SOAP message over HTTP 89 specification for custom processor 485 specification for target service 485 submitting an RPC request 97 unregistering handlers, consumer 462 unregistering handlers, provider 463 unregistering processors 467 validating SOAP objects 489 SOAP messages, inserting trailer 472 SOAP services 457 soapClient 89 soapDataToString 487 SOAPFault 598 soapHTTP 93 soapRPC 97 special characters handling in XML strings 653 specifications alarm event handler 153 audit event handler 154 exception event handler 157 gdEnd 159 gdStart 160 portStatus event handler 171 replication event handler 172 sessionEnd event handler 177 sessionExpire event handler 178 sessionStart event handler 179 stat event handler 180 txEnd event handler 183 txStart event handler 184 SQL statements, executing 124 starting a guaranteed delivery transaction 375 startTransaction 44, 138 stat specification 180 statInfo document type 182 status of guaranteed delivery transactions 372 STOR or STOU commands, sending to remote server using pub.client ftp service 53 using pub.client.ftp mput service 67 put service 68 storage services 491
stored procedures invoking 115 retrieving information about 128 retrieving names of 129 streamToBytes 212 streamToSoapData 487 string array, formatting 512 stringListToDocumentList 286 strings adding to list 285 base64 decoding 507 base64 encoding 507 byte array conversion 508 concatenating 508 concatenating an array of strings 512 converted from documents 145 converting list to document list 286 converting to byte array 516 converting to lowercase 517 converting to uppercase 517 decoding URL-encoded 518 HTML to native characters 508 length of 510 native characters to HTML 509 padding beginning 514 padding end 515 replacing all 515 returning substring of 516 tokenizing into an array 518 transformation services 505 trimming white space 518 URL-encoding 519 XML values to a document 145 stringToBytes 516 stringToSoapData 488 submitting an asynchronous call to a remote server 376 subscribing to packages 377 subscriptions, creating 150 substring 516 indexing first occurrence 510 subtractFloats 298 subtractInts 299 subtractObjects 299 subtype, getting from MIME message 319 sum of numeric values 289, 290, 291 suspended tasks, resuming 409
701
Index
suspending document processing for triggers 558 document retrieval for triggers 561 suspendListener 33 suspendPollingNotification 40 suspendTask 410 synchronization services coordinating the execution of services 521 performing latching and cross-referencing operations 525 synchronous call to a remote server 373 synchronous request/reply delivering a request 347 description of 348, 361 publishing a request 359
T
tables inserting rows 134 removing rows 123 retrieving column information 130 retrieving names of 132 retrieving rows from 135 updating all rows 139 tasks adding complex to scheduler 394 adding one-time to scheduler 397 adding recurring to scheduler 400 obtaining information about 404 removing from scheduler 403 resuming 409 retrieving IDs for 403 suspending 410 updating complex to scheduler 410 updating one-time to scheduler 414 updating repeating to scheduler 416 templates applying to a document 388 applying to pipeline 389 from string objects 389 time zones 105 time, converting formats 110 time/date transformation services 103 tModel 598 tModelBag 599 tModelDetail 599 tModelInfo 600 tModelInfos 600
tModelInstanceDetails 600 tModelInstanceInfo 601 tModelKey 601 tModelList 601 tokenizing a string 518 toKey 602 toLower 517 toUpper 517 tracePipeline 202 trailers, adding to SOAP messages 472 transactional state, clearing 118 transactions, ending guaranteed delivery 372 transforming date formats 103 time formats 103 transforming XML 682 transient error, description of 202 transportInfo 203 trigger services retry count 195 retrying 201 triggers management services 535 resuming document processing 550 resuming document retrieval 553 suspending document retrieval 561 suspending processing 558 trimming white space 518 troubleshooting information 22 txEnd specification 183 txEndInfo document type 183 txStart specification 184 txStartInfo document type 184 typographical conventions in this document 21
U
UDDI services 565 universal name services 637 universal names finding service names for 638 listing the registry 638 unlocking entries in data stores 502 unregisterProcessor 467 unsubscribing from an event 156 updateComplexTask 410 updateOneTimeTask 414 updateRepeatingTask 416
702
Index
updating attributes in an LDAP directory 281 rows in a database table 139 uploadRegister 602 uppercase, converting to 517 URLDecode 518 URLEncode 519 user management, VCS 643 get user names 644 remove current user 645 remove multiple users 645 set current user 646 set multiple users 647 Utils services retrieves value of server property 641
provider registering the handler 462 unregistering the handler 463 white space, trimming 518 WmSecureString 441 converting 442 creating 441 destroying 443 working directory, changing 56
X
XML datatypes 427 pub.schema.w3c 428 XML documents converting to IData objects 669 converting to XML nodes 678 XML nodes creating from XML string 678 extracting data from 667 freeing 657 getting type info 660 loading from URL 661 querying 667 XML services 649 XML strings, creating from documents 650 handling special characters 653 XML values converting from a document 145 converting to a document 145 xmlNodeToDocument 669 xmlStringToXMLNode 678 XMLValuesToDocument 145 XQL queries 667 XSLT services maintaining the stylesheet cache 681 transforming an XML stream 681
V
validatePipeline 426 validateSoapData 489 validating an object 425 VCS Integration feature 643 getting users 644 remove current user 645 remove multiple users 645 set current user 646 set multiple users 647 verifying digital signatures 438 verifying signed data objects 333 volatile storage, for reply documents 362
W
waitForReply service 364 waiting for delivery from a notifying service 522 watt.security.ope.AllowInternalPasswordAccess 434 Web service descriptor consumer registering the handler 462 unregistering the handler 462
703
Index
704

7-1-1 Integration Server Built-In Services Reference

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

7-1-1 Integration Server Built-In Services Reference

Uploaded by

Copyright:

Available Formats

TitlePage

webMethods Integration Server

Copyright & Docu mentID

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

About This Guide

client cluster date db

49 101 103 113

document event file flow io jms ldap

141 147 187 191 207 213 271

webMethods Integration Server Built-In Services Reference Version 7.1.1

About This Guide

Folder math mime packages pki

Page 287 301 323 331

publish remote replicator report scheduler schema security

343 369 377 387 393 421 429

smime soap storage string sync synchronization trigger

445 457 491 505 521 525 535

webMethods Integration Server Built-In Services Reference Version 7.1.1

About This Guide

universalName vcs utils xml xslt

637 643 641 649 681

webMethods Integration Server Built-In Services Reference Version 7.1.1

About This Guide

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

Summary of Elements in this Folder

pub.art.connection:disableConnection pub.art.connection:enableConnection pub.art.connection:getConnectionStatistics pub.art.connection:listAdapterConnections pub.art.connection:queryConnectionState

webMethods Integration Server Built-In Services Reference Version 7.1.1

Element pub.art.notification:enablePollingNotification pub.art.notification:listAdapterListenerNotifications

pub.art.notification:queryPollingNotificationState pub.art.notification:resumePollingNotification pub.art.notification:setListenerNotificationNodeListener pub.art.notification:setPollingNotificationNodeConnection

pub.art.notification:suspendPollingNotification pub.art.service:listAdapterServices pub.art.service:setAdapterServiceNodeConnection

pub.art.transaction:commitTransaction pub.art.transaction:rollbackTransaction pub.art.transaction:setTransactionTimeout

webMethods Integration Server Built-In Services Reference Version 7.1.1

webMethods Integration Server Built-In Services Reference Version 7.1.1

Output Parameters None. See Also pub.art.connection:disableConnection

See Also pub.art.connection:queryConnectionState

webMethods Integration Server Built-In Services Reference Version 7.1.1

Description Connectionnodeisdisabled. Connectionnodeisenabled. Connectionnodeisinthe processofshuttingdown. Connectionnodeis registeredbuthasnotyet establisheditsstate.

See Also pub.art:listRegisteredAdapters pub.art.connection:queryConnectionState

webMethods Integration Server Built-In Services Reference Version 7.1.1

Description Anerrorwasdetected. Noerrorwasdetected.

See Also pub.art.connection:getConnectionStatistics pub.art.connection:enableConnection pub.art.connection:disableConnection

Description Forcethedisable. Donotforcethedisable.

webMethods Integration Server Built-In Services Reference Version 7.1.1

Output Parameters None. See Also pub.art.listener:enableListener

webMethods Integration Server Built-In Services Reference Version 7.1.1

StringThenameofthepackageinwhichthe listenerresides. StringCurrentstateofthelistener.Thestate willhaveoneofthesevalues: Value

See Also pub.art:listRegisteredAdapters pub.art.listener:queryListenerState