Kofax Communications Manager Batch & Output Management Scripting Language Developer's Guide Version: 5.4.0 Date: 2020-08-26 © 2018–2020 Kofax. All rights reserved. Kofax is a trademark of Kofax, Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Kofax. Table of Contents Preface.......................................................................................................................................................... 5 Related documentation.......................................................................................................................5 Getting help with Kofax products.......................................................................................................6 Chapter 1: Standard processes: scripts and functions..........................................................................8 Structure of the standard processes..................................................................................................8 Electronic output...................................................................................................................... 8 Printed output.........................................................................................................................10 CCM_CleanUpAll................................................................................................................... 17 Processing component functions..................................................................................................... 17 RegisterRequest function.......................................................................................................17 ProcessRequest function.......................................................................................................17 CommunicateCorrespondence function.................................................................................18 DeliverCommunication function (for electronic output)..........................................................19 DeliverCommunication function (for printed output)..............................................................19 CreateRenditionForSelectedProcess function....................................................................... 20 Bundling component functions.............................................................................................. 21 Stacking component functions...............................................................................................25 Streaming component function..............................................................................................28 Conversion component functions.......................................................................................... 29 Distribution component functions.......................................................................................... 31 GarbageCollection component functions...............................................................................32 Chapter 2: Custom scripting................................................................................................................... 34 Configure the accounting functionality............................................................................................. 34 Configure a custom database for accounting....................................................................... 34 Initiate request accounting.....................................................................................................35 Initiate communication accounting........................................................................................ 36 Add and modify document pages in streaming............................................................................... 38 Include additional pages for stack, envelope, or document..................................................38 Modify a document page.......................................................................................................39 Insert a bar code on a document page................................................................................ 41 Configure the distribution functionality............................................................................................. 42 Chapter 3: Batch & Output Management scripting language.............................................................. 44 Create scripts and conditions...........................................................................................................44 Create a script....................................................................................................................... 44 3 Kofax Communications Manager Batch & Output Management Scripting Language Developer's Guide Create a condition................................................................................................................. 44 View context information....................................................................................................... 45 Create a script parameter..................................................................................................... 45 Assign a script to an event................................................................................................... 46 Script and condition editor tools............................................................................................46 Useful key combinations........................................................................................................47 Debug a script or condition................................................................................................... 47 Scripting functions............................................................................................................................ 49 Data types..............................................................................................................................49 Control structures...................................................................................................................50 Exception handling.................................................................................................................52 Standard functions.................................................................................................................54 Date functions........................................................................................................................88 File processing functions.......................................................................................................92 XML processing functions................................................................................................... 106 Array functions.....................................................................................................................108 Object functions................................................................................................................... 109 Scripting contexts........................................................................................................................... 111 Process................................................................................................................................ 111 OnProcessError....................................................................................................................112 StreamingUnit.......................................................................................................................113 StreamingPage.....................................................................................................................118 StackDistribution.................................................................................................................. 120 Appendix A: Encoding parameters....................................................................................................... 122 Appendix B: HTML color names........................................................................................................... 127 4 Preface This guide provides detailed information on the scripts used in the standard processes in KCM Studio and describes the scripting language of KCM Batch & Output Management (also known as KCM B&OM). Related documentation The documentation set for Kofax Communications Manager is available here:1 https://docshield.kofax.com/Portal/Products/KCM/5.4.0-cli2a1c07m/KCM.htm In addition to this guide, the documentation set includes the following items: Kofax Communications Manager Release Notes Contains late-breaking details and other information that is not available in your other Kofax Communications Manager documentation. Kofax Communications Manager Technical Specifications Provides information on supported operating system and other system requirement for Kofax Communications Manager. Kofax Communications Manager Installation Guide Contains instructions on installing and configuring Kofax Communications Manager and its components. Kofax Communications Manager Getting Started Guide Describes how to use Contract Manager to manage instances of Kofax Communications Manager. Kofax Communications Manager Batch & Output Management Getting Started Guide Describes how to start working with Batch & Output Management. Kofax Communications Manager Repository Administrator's