DOCSLIB.ORG

Kofax Communications Manager Batch & Output Management Scripting Language Developer's Guide

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
Kofax Communications Manager Batch & Output Management Scripting Language Developer's Guide 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
Load more

Recommended publications
  • Wireless October 1985 85P
    Wireless October 1985 85p 68000 computer board Memory expansion Switched -mode power supply Multi-standard digital terminal Australia AS 3.30 Spain Pts. 370.00 Denmark DKr. 38.00 Switzerland SFr. 8.00 Germany DM 7.00 Singapore MS 7.00 Holland DPI. 9.00 U.S.A. S 4.00 Italy. L 4200 www.americanradiohistory.com DUAL TRACE THE ANSWER TEKOSCILLOSCOPES BY ANY MEASURE Now! Tek quality and expert advice are just a free phone call away... Our National Order Desk line gets you fast delivery of the industry's leading value/ performance portables... and technical advice from experts! The 60MHz 2213A, 2215A and the 100MHz 2235 and 2236 These UK offer unprecedented reliability anufactured 'scopes are and affordability, plus the obtainable through the industry's first 3 year warranty National Order Desk. Call us on labour and parts, CRT to order or obtain literature, included. or to talk to our expert on All 2200 series scopes scope applications. have the bandwidth for digital ..talk circuits and sensitivity for low signal analogue measurement. The sweep speeds for fast logic families, and delayed sweep for to Pete fast, accurate timing Dial 100 and ask for measurement. The top of the range 2236 combines a Freefone Tek- scope counter/timer/DMM with the Tektronix UK Ltd scope to provide fast, easy Fourth Avenue, Globe Park, measurements for voltage, Marlow, Bucks SL7 1YD Tel: (06284) 6000 resistance and temperature. Telex: 847277 & 847378 The Company reserves the right to modify designs, speci'ications and change prices without notice. Tektronix (:I)MMI1Fflll.If 1.IIItNI.1 CIRCLE 1 FOR FURTHER INFORMATION www.americanradiohistory.com Editor ELECTRONICS PHILIP DARRINGTON Deputy Editor GEOFFREY SHORTER, B.Sc.
    [Show full text]
  • Kaleido-X User's Manual
    Kaleido-X User’s Manual Part Number: M770-2800-111 1 June 2011 Copyright © 2007-2011 Miranda Technologies Inc. All rights reserved. ATTENTION: please read the following terms and conditions carefully. By using Kaleido-X documentation, you agree to the following terms and conditions: Miranda Technologies Inc. hereby grants permission and license to owners of Kaleido-X to use their product manuals for their own internal business use. Manuals for Miranda Technologies Inc. products may not be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose unless specifically authorized in writing by Miranda Technologies Inc. A Miranda Technologies Inc. manual may have been revised to reflect changes made to the product during its manufacturing life. Thus, different versions of a manual may exist for any given product. Care should be taken to ensure that one obtains the proper manual version for a specific product serial number. Information in this document is subject to change without notice and does not represent a commitment on the part of Miranda Technologies Inc. Title Kaleido-X User’s Manual Part Number M770-2800-111 Revision 1 June 2011, 4:37 pm ii Table of Contents 1 New Features 1 Overview. 1 New Feature in Kaleido-X Version 5.30. 1 Features Introduced in Kaleido-X Version 5.20 . 2 Features Introduced in Kaleido-X Version 5.10 . 2 2 Getting Started 5 About this Document . 5 System Overview. 6 Kaleido-Modular . 6 Kaleido-X16. 8 Kaleido-X (4RU) . 10 Kaleido-X (7RU) . 11 Kaleido-X (7RU) x 2 Expansion .
    [Show full text]
  • Introduction to Closed Captions
    TECHNICAL PAPER Introduction to Closed Captions By Glenn Eguchi Senior Computer Scientist April 2015 © 2015 Adobe Systems Incorporated. All rights reserved. If this whitepaper is distributed with software that includes an end user agreement, this guide, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part of this guide may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Adobe Systems Incorporated. Please note that the content in this guide is protected under copyright law even if it is not distributed with software that includes an end user license agreement. The content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this guide. This article is intended for US audiences only. Any references to company names in sample templates are for demonstration purposes only and are not intended to refer to any actual organization. Adobe and the Adobe logo, and Adobe Primetime are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA. Notice to U.S. Government End Users.
    [Show full text]
  • Powerserver Configuration Guide for .NET
    PowerServer Configuration Guide for .NET Appeon® PowerServer® 2017 (on .NET) FOR WINDOWS DOCUMENT ID: ADC20240-01-0700-01 LAST REVISED: October 27, 2017 Copyright © 2000-2017 by Appeon Limited. All rights reserved. This publication pertains to Appeon software and to any subsequent release until otherwise indicated in new editions or technical notes. Information in this document is subject to change without notice. The software described herein is furnished under a license agreement, and it may be used or copied only in accordance with the terms of that agreement. No part of this publication may be reproduced, transmitted, or translated in any form or by any means, electronic, mechanical, manual, optical, or otherwise, without the prior written permission of Appeon Limited. Appeon, the Appeon logo, Appeon PowerBuilder, Appeon PowerServer, PowerServer, PowerServer Toolkit, AEM, and PowerServer Web Component are trademarks of Appeon Limited. SAP, Sybase, Adaptive Server Anywhere, SQL Anywhere, Adaptive Server Enterprise, iAnywhere, Sybase Central, and Sybase jConnect for JDBC are trademarks or registered trademarks of SAP and SAP affiliate company. Java and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. All other company and product names used herein may be trademarks or registered trademarks of their respective companies. Use, duplication, or disclosure by the government is subject to the restrictions set forth in subparagraph (c)(1)(ii) of DFARS 52.227-7013 for the DOD and as set forth in FAR 52.227-19(a)-(d) for civilian agencies. Appeon Limited, 1/F, Shell Industrial Building, 12 Lee Chung Street, Chai Wan District, Hong Kong. Contents 1 About This Book ...................................................................................................
    [Show full text]
  • DVB); Specification for Service Information (SI) in DVB Systems
    Final draft ETSI EN 300 468 V1.5.1 (2003-01) European Standard (Telecommunications series) Digital Video Broadcasting (DVB); Specification for Service Information (SI) in DVB systems European Broadcasting Union Union Européenne de Radio-Télévision EBU·UER 2 Final draft ETSI EN 300 468 V1.5.1 (2003-01) Reference REN/JTC-DVB-128 Keywords broadcasting, digital, DVB, MPEG, service, TV, video ETSI 650 Route des Lucioles F-06921 Sophia Antipolis Cedex - FRANCE Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 Siret N° 348 623 562 00017 - NAF 742 C Association à but non lucratif enregistrée à la Sous-Préfecture de Grasse (06) N° 7803/88 Important notice Individual copies of the present document can be downloaded from: http://www.etsi.org The present document may be made available in more than one electronic version or in print. In any case of existing or perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF). In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive within ETSI Secretariat. Users of the present document should be aware that the document may be subject to revision or change of status. Information on the current status of this and other ETSI documents is available at http://portal.etsi.org/tb/status/status.asp If you find errors in the present document, send your comment to: [email protected] Copyright Notification No part may be reproduced except as authorized by written permission.
    [Show full text]
  • International Register of Coded Character Sets to Be Used with Escape Sequences for Information Interchange in Data Processing
    INTERNATIONAL REGISTER OF CODED CHARACTER SETS TO BE USED WITH ESCAPE SEQUENCES 1 Introduction 1.1 General This document is the ISO International Register of Coded Character Sets To Be Used With Escape Sequences for information interchange in data processing. It is compiled in accordance with the provisions of ISO/IEC 2022, "Code Extension Technique" and of ISO 2375 "Procedure for Registration of Escape Sequences". This International Register contains coded character sets which have been registered in accordance with procedures given in ISO 2375. Its purpose is to identify widely used coded character sets and associate with each a unique escape sequence by means of which it can be designated according to ISO/IEC 2022 and ISO/IEC 4873. The publication of this International Register should promote compatibility in international information interchange and avoid duplication of effort in developing application-oriented coded character sets. Registration provides an identification for a coded character set but implies nothing about its status; it may or may not be part of a standard of an international, national or a corporate body. However, if such a standard is published subsequently to the registration, it would be appropriate for the escape sequence identifying the character set to be specified in the standard. If it is desired to register a set, application should be made to the Registration Authority through an appropriate Sponsoring Authority as specified in ISO 2375. Any character set can be a candidate for registration if it meets the requirements of ISO 2375. The Registration Authority ascertains that the proposals received are formally in accordance with this International Standard, technically in accordance with ISO/IEC 2022, and, where applicable, with ISO/IEC 646 and ISO/IEC 4873, and meet the presentation practice of the Registration Authority.
    [Show full text]
  • Windows Mbox Viewer User Manual 1.0.2.6 Table of Contents 1 Modification History
    Windows MBox Viewer User Manual 1.0.2.6 Table of Contents 1 Modification History.......................................................................................................................3 2 Feedback..........................................................................................................................................3 3 Overview.........................................................................................................................................4 4 Installation.......................................................................................................................................4 5 Running the MBox viewer..............................................................................................................4 5.1 Argument List Summary..............................................................................................................4 5.2 Setting Options from GUI............................................................................................................5 5.3 Basic Use Case.............................................................................................................................6 5.4 Mail Context Menu.......................................................................................................................7 5.5 Mail Archive Context menu.........................................................................................................8 5.6 Mail Attachments..........................................................................................................................9
    [Show full text]
  • (Tech 3264) to Ebu-Tt Subtitle Files
    TECH 3360 EBU-TT, PART 2 MAPPING EBU STL (TECH 3264) TO EBU-TT SUBTITLE FILES VERSION 1.0 SOURCE: SP/MIM – XML SUBTITLES Geneva May 2017 There are blank pages throughout this document. This document is paginated for two sided printing Tech 3360 - Version 1.0 EBU-TT Part 2 - EBU STL Mapping to EBU-TT Conformance Notation This document contains both normative text and informative text. All text is normative except for that in the Introduction, any section explicitly labelled as ‘Informative’ or individual paragraphs which start with ‘Note:’ Normative text describes indispensable or mandatory elements. It contains the conformance keywords ‘shall’, ‘should’ or ‘may’, defined as follows: ‘Shall’ and ‘shall not’: Indicate requirements to be followed strictly and from which no deviation is permitted in order to conform to the document. ‘Should’ and ‘should not’: Indicate that, among several possibilities, one is recommended as particularly suitable, without mentioning or excluding others. OR indicate that a certain course of action is preferred but not necessarily required. OR indicate that (in the negative form) a certain possibility or course of action is deprecated but not prohibited. ‘May’ and ‘need not’: Indicate a course of action permissible within the limits of the document. Default identifies mandatory (in phrases containing “shall”) or recommended (in phrases containing “should”) values that can, optionally, be overwritten by user action or supplemented with other options in advanced applications. Mandatory defaults must be supported. The support of recommended defaults is preferred, but not necessarily required. Informative text is potentially helpful to the user, but it is not indispensable and it does not affect the normative text.
    [Show full text]
  • [MS-UCODEREF]: Windows Protocols Unicode Reference
    [MS-UCODEREF]: Windows Protocols Unicode Reference Intellectual Property Rights Notice for Open Specifications Documentation . Technical Documentation. Microsoft publishes Open Specifications documentation for protocols, file formats, languages, standards as well as overviews of the interaction among each of these technologies. Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you may make copies of it in order to develop implementations of the technologies described in the Open Specifications and may distribute portions of it in your implementations using these technologies or your documentation as necessary to properly document the implementation. You may also distribute in your implementation, with or without modification, any schema, IDL's, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications. No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation. Patents. Microsoft has patents that may cover your implementations of the technologies described in the Open Specifications. Neither this notice nor Microsoft's delivery of the documentation grants any licenses under those or any other Microsoft patents. However, a given Open Specification may be covered by Microsoft Open Specification Promise or the Community Promise. If you would prefer a written license, or if the technologies described in the Open Specifications are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting [email protected]. Trademarks. The names of companies and products contained in this documentation may be covered by trademarks or similar intellectual property rights.
    [Show full text]
  • Beocollectors.Com
    Þ»±Ê·•·±² ߪ¿²¬ ÎÚ îèŒ ú ߪ¿²¬ ÎÚ íîŒ Þ»±Ê·•·±² ߪ¿²¬ ÎÚ ÝÌÊ Ì§°» èíí¨ô èìí¨ Ì§°» èíé¨ Í»®ª·½» Ó¿²«¿´ Û²¹´·•¸ô Ù»®³¿²ô Ú®»²½¸ô ׬¿´·¿²ô Í°¿²·•¸ BeoCollectors.com BeoCollectors.com BeoCollectors.com BeoCollectors.com ÓßÍÌÛÎ Ô×ÒÕ Ð·² ï Ü¿¬¿ó óðòîëÊ oðòïÊ ½¿¬·±² ¬± ±¬¸»® ÌÊ ¬®¿²•³·••·±² •§•¬»³• øÌÊ ±²´§÷ з² î Ü¿¬¿õ õðòîëÊ oðòïÊ Ì§°» ͧ•¬»³ Ó±¼ò ÊÌΠ̧°» ÞñÙ ÞñÙñÔñÔŽñ×ñÜñÕ ÞñÙñÔñ×ñÓñÜñÕ Í§•¬»³ B з² í ÓÔ •»²•» èìíð ÞñÙ ÛË ÞñÙ ììëí ÞñÙ øßî ÞñÙ÷ èðððîçì èðððîçë ±® ììëï Þñ٠з² ìóïð ÒòÝò øßîô Ò×ÝßÓ ÞñÙ÷ èìíî ×ñÓñÜñÕ ØÕ × ììëç ×ñÜñÕ øÒ×ÝßÓ ×÷ î èðððîçì î eoз² ïï ó•«°°´§ ª±´¬¿¹» óéÊ ¬± óïëÊ ø·² •¬¿²¼¾§ óíÊ ¬± óïëÊ÷ èìíí × ÙÞ × ììëç ×ñÜñÕ øÒ×ÝßÓ ×÷ ï ï èðððîçë èìíì ÞñÙ ×ÌßÔÇ ÞñÙ ììëí ÞñÙ øßî ÞñÙ÷ èðððîçì èðððîçë з² ïî õ•«°°´§ ª±´¬¿¹» õéÊ ¬± õïëÊ ø·² •¬¿²¼¾§ õíÊ ¬± õïëÊ÷ èìíë ÞñÙ ßËÍ ÞñÙ ììëí ÞñÙ øßî ÞñÙ÷ èðððîçì èðððîçë ±® ììëï Þñ٠з² ïí ß«¼·± óÔ ïÊ Þ¿´ô η² îòîÓ±¸³•ô ᫬ é뱸³• øßîô Ò×ÝßÓ ÞñÙ÷ èìíê ÞñÙñÜñÕ ÛÛË ÞñÙ ììëê ÞñÙñÜñÕ ï èðððîçë з² ïì ß«¼·± õÔ ïÊ Þ¿´ô η² îòîÓ±¸³•ô ᫬ éëÓ±¸³• øßîô Ò×ÝßÓ ÞñÙñÜñÕ÷ èìíé ÞñÙñ×ñÓñÜñÕ Ìß× ÞñÙ ììëí ÞñÙ øßî ÞñÙ÷ èðððîçì î C з² ïë ß«¼·± óÎ ïÊ Þ¿´ô η² îòîÓ±¸³•ô ᫬ é뱸³• ±® ììëï ÞñÙ øßîô Ò×ÝßÓ ÞñÙ÷ з² ïê ß«¼·± õÎ ïÊ Þ¿´ô η² îòîÓ±¸³•ô ᫬ é뱸³• èìíè ÞñÙñÔñÔŽ ÚøÙÞ÷ ÞñÙ ììëë ÞñÙñÔñÔŽñ× ï èðððîçë ßî ÞñÙô o Ò×ÝßÓ ÞñÙñÔñ×÷ ÍóÊØÍ Ð·² ï Ç ÙÒÜ ll з² î Ý ÙÒÜ Ð·² í Ô«³·²¿²½» ·² øÇ÷ ï Ê°° éë ±¸³• e з² ì ݸ®±³·²¿²½» ·² øÝ÷ ï Ê°° éë ±¸³• ½¿¬·±² ¬± ±¬¸»® ÌÊ ¬®¿²•³·••·±² •§•¬»³• øÌÊ ±²´§÷ ̧°» ͧ•¬»³ Ó±¼ò ÊÌΠ̧°» ÞñÙ ÞñÙñÔñÔŽñ×ñÜñÕ ÞñÙñÔñ×ñÓñÜñÕ Ê×ÜÛÑ Ý±³°±•·¬» ª·¼»± ·² ïÊ°° éë ±¸³• ͧ•¬»³ c èííð ÞñÙ ÛË ÞñÙ ììëí
    [Show full text]
  • Appeon Server Configuration Guide for .NET*
    Appeon Server Configuration Guide for .NET* Appeon® 6.0 for PowerBuilder® WINDOWS Not available in Sybase Distribution. For differences of distributions, refer to the Distributions section in Introduction to Appeon. DOCUMENT ID: DC00812-01-0600-03 LAST REVISED: July 2008 Copyright © 2008 by Appeon Corporation. All rights reserved. This publication pertains to Appeon software and to any subsequent release until otherwise indicated in new editions or technical notes. Information in this document is subject to change without notice. The software described herein is furnished under a license agreement, and it may be used or copied only in accordance with the terms of that agreement. No part of this publication may be reproduced, transmitted, or translated in any form or by any means, electronic, mechanical, manual, optical, or otherwise, without the prior written permission of Appeon Corporation. Appeon, the Appeon logo, Appeon Developer, Appeon Enterprise Manager, AEM, Appeon Server and Appeon Server Web Component are trademarks or registered trademarks of Appeon Corporation. Sybase, Adaptive Server Anywhere, Adaptive Server Enterprise, iAnywhere and PowerBuilder, are trademarks or registered trademarks of Sybase, Inc. Java, JDBC and JDK are trademarks or registered trademarks of Sun, Inc. All other company and product names used herein may be trademarks or registered trademarks of their respective companies. Use, duplication, or disclosure by the government is subject to the restrictions set forth in subparagraph (c)(1)(ii) of DFARS 52.227-7013 for the DOD and as set forth in FAR 52.227- 19(a)-(d) for civilian agencies. Appeon Corporation, 1/F, Shell Industrial Building, 12 Lee Chung Street, Chai Wan District, Hong Kong.
    [Show full text]
  • Unicode - I18N
    Encodings - Unicode - I18N Généralités......................................................................................................................................................................3 Locales............................................................................................................................................................................6 Locale..........................................................................................................................................................................6 Character encoding.....................................................................................................................................................6 Code pages..................................................................................................................................................................6 Codepage Identifiers...................................................................................................................................................7 GetCPInfo...................................................................................................................................................................9 setlocale.....................................................................................................................................................................10 Preprocessor directive...............................................................................................................................................12
    [Show full text]