iWay Service Manager Component Reference Guide Version 8.0 and Higher September 17, 2018 Active Technologies, EDA, EDA/SQL, FIDEL, FOCUS, Information Builders, the Information Builders logo, iWay, iWay Software, Parlay, PC/FOCUS, RStat, Table Talk, Web390, WebFOCUS, WebFOCUS Active Technologies, and WebFOCUS Magnify are registered trademarks, and DataMigrator and Hyperstage are trademarks of Information Builders, Inc. Adobe, the Adobe logo, Acrobat, Adobe Reader, Flash, Adobe Flash Builder, Flex, and PostScript are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Due to the nature of this material, this document refers to numerous hardware and software products by their trademarks. In most, if not all cases, these designations are claimed as trademarks or registered trademarks by their respective companies. It is not this publisher's intent to use any of these names generically. The reader is therefore cautioned to investigate all claimed trademark rights before using any of these names other than to refer to the product described. Copyright © 2018, by Information Builders, Inc. and iWay Software. All rights reserved. Patent Pending. This manual, or parts thereof, may not be reproduced in any form without the written permission of Information Builders, Inc. Contents Preface ........................................................................ 15 Documentation Conventions .......................................................... 15 Related Publications .................................................................16 Customer Support ...................................................................16 Help Us to Serve You Better .......................................................... 17 User Feedback ......................................................................19 iWay Software Training and Professional Services ........................................19 1. iWay Services ................................................................21 Services Overview ................................................................... 21 Available Services ...................................................................26 Accum EOS Agent (com.ibi.agents.XDAccumEOSAgent)...............................26 Accumulates Document Iterations (com.ibi.agents.XDAccumIterAgent)..................30 Activity Log Business Error Message (com.ibi.agentsXDXALogBizErr)................... 31 Activity Log Control Service (com.ibi.agents.XDXalogControlAgent)..................... 33 Activity Log Entry Service (com.ibi.agents.XDXALogEvent).............................34 Add Attachment From File Service (com.ibi.agents.XDAddAttachmentFromFileAgent)......37 Add Attachment Service (com.ibi.agents.XDAddAttachmentAgent)......................40 Add Correl Entry Service (com.ibi.agents.XDAddCorrelEntryAgent)......................42 Alt Route IP Service (com.ibi.agents.XDAltRouteIP).................................. 43 Append Stream to File Service (com.ibi.agents.XDFileAppendAgent)....................44 AQ Emit Service (com.ibi.agents.XDAQEmitAgent)....................................45 AS2 Nonblocking Emit Service (com.ibi.agents.XDNAS2EmitAgent).....................49 AS 1 Emit Service (com.ibi.agents.AS1EmitAgent)...................................56 AS 2 Emit Service (com.ibi.agents.AS2EmitAgent)...................................59 AS 2 Nonblocking Send MDN Service (com.ibi.agents.XDMDNSendNowAgent)...........65 Attachment Iterator Service (com.ibi.agents.XDIterAttachments).......................66 Attachment Operations Service (com.ibi.agents.XDAttachOps).........................68 Attachment to Document Service (com.ibi.agents.XDAttachmentToDocAgent)............69 Attachment to File Service (com.ibi.agents.XDAttachmentToFileAgent)..................71 Authenticate/Impersonate Service (com.ibi.agents.XDPrincipalAgent).................. 73 BAM Receiver Service (com.ibi.agents.BAMReceiver).................................74 Base64 Operation Service (com.ibi.agents.XDBase64Agent)..........................76 iWay Service Manager Component Reference Guide 3 Contents Bearer Token Agent Service (com.ibi.agents.XDBearerTokenAgent).....................78 Blank Elimination Service (com.ibi.agents.XDBlankWalk)............................. 81 Cancel Service (com.ibi.agents.XDCancelAgent).....................................82 Catch Service (com.ibi.agents.XDCatchAgent).......................................85 Channel Information Service (com.ibi.agents.XDChanInfoAgent)....................... 89 Check Schema Service (com.ibi.agents.XDCheckSchema)............................ 92 Commit or Rollback within a Flow (com.ibi.agents.XDCommitAgent).................... 96 Constant Service (com.ibi.agents.XDConstantAgent).................................98 Controls Listeners Service (com.ibi.agents.XDControlAgent)......................... 100 Control Activity Log Exit Service (com.ibi.agents.XDXalogControlAgent)................ 103 Cookie Store Agent Service (com.ibi.agents.XDCookieStoreAgent).................... 104 Correl Inquiry By State Service (com.ibi.agents.XDCorrelInquiryByStateAgent)...........105 Correl Inquiry Service (com.ibi.agents.XDCorrelInquiryAgent)......................... 107 Correl Set Inquiry Service (com.ibi.agents.XDCorrelSetInquiryAgent)...................108 C Char Filter Service (com.ibi.agents.CCharFilter)...................................109 Cross-Origin Resource Sharing Service (com.ibi.agents.XDCorsAgent).................111 Examples................................................................115 Data Quality Center Service (Non-Pooling, Deprecated) (com.ibi.agents.XDDQAgent).....117 Deflate Service (com.ibi.agents.XDDeflateAgent)...................................118 Deidentification Service (com.ibi.agents.XDDeidentifyAgent)......................... 119 Delete an Item (com.ibi.agents.XDDynamoDBDeleteItem)........................... 128 destroy status Service (com.ibi.agents.XDTwitterDestroyStatus)......................130 Document Copy Service (com.ibi.agents.XDCopyAgent)..............................132 Document Insert Service (com.ibi.agents.XDDocInsertAgent).........................133 Example 1: Charter Data.................................................. 136 Example 2: Creating the Parent.............................................137 Example 3: Inserting an Element............................................138 Example 4: Inheriting XML Namspaces...................................... 139 Document state modification Service (com.ibi.agents.XDDocAgent)...................140 Document Update Service (com.ibi.agents.XDDocUpdateAgent)...................... 141 Example 1: Find/Replace Then Build Document...............................146 Example 2: Build Document Then Find/Replace...............................147 Example 3: Only Find/Replace..............................................148 4 Information Builders Contents Example 4: Only Build Document........................................... 149 Example 5: Find/Replace Then Build Document...............................150 Example 6: Build Document Then Find/Replace...............................151 Example 7: Only Find/Replace..............................................152 Example 8: Only Build Document........................................... 153 Document to Attachment Service (com.ibi.agents.XDAttachmentFromDocAgent)........ 154 DQC Batch Executor Service (com.ibi.agents.XDDQBatchExec)....................... 156 DQC/MDC Flow Linkage Service (com.ibi.agents.MdcAgentISM)......................157 Data Quality Center Service (Document-Driven, Pooling) (com.ibi.agents.XDDQAgent2)...159 Configuring Data Quality Runtime Providers.................................. 161 Data Quality Center Service (User Parameter-Driven, Pooling) (com.ibi.agents.XDDQAgent2UserParm)........................................163 Using the Data Quality Center Service (User Parameter-Driven, Pooling).......... 165 EDI Accumulator Service (com.ibi.agents.EDIAccumulator)...........................168 EDI Rule Router Service (com.ibi.agents.XDRuleRouterAgent)........................169 EDIFACTAckAgent (com.ibi.agents.XDEDIFACTAckAgent).............................170 EDIFACT ValidationReportAgent (com.ibi.agents.XDEDIFACTValidationReportAgent)......171 EDIHL7AckAgent (com.ibi.agents.XDEDIHL7AckAgent)...............................172 EDIHL7 ValidationReport Agent (com.ibi.agents.XDEDIHL7ValidatioReportAgent)........173 EDIWrapperAgent Service (com.ibi.agents.EDIWrapperAgent).........................174 EDIX12TransformAgent Service (com.ibi.agents.XDEDITransformAgent)................175 EDIX12AckAgent Service (com.ibi.agents.XDX12AckAgent)...........................176 Email Emit Service (com.ibi.agents.XDEmailEmitAgent)..............................177 Entag Service (com.ibi.agents.XDEntagAgent)......................................182 Ethereum Call Agent Service (com.ibi.agents.XDEthereumCallAgent).................. 183 Ethereum Call Constant Function Agent Service (com.ibi.agents.XDEthereumCallConstantAgent).................................185 Ethereum Deploy Agent Service (com.ibi.agents.XDEthereumDeployAgent).............186 Ethereum Transfer Agent Service (com.ibi.agents.XDEthereumTransferAgent).......... 187 Excel reader Service (com.ibi.agents.XDReadExcel).................................189 Execute ETL Service (com.ibi.agents.XDETLAgent)..................................190 Fail Service (com.ibi.agents.XDFailAgent)..........................................192