Implementation Best Practice Guide Version 1.0 Release July 2016 Lexmark believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. The information in this publication is provided as is. Lexmark makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any Lexmark software described in this publication requires an applicable software license. For information on Lexmark product names and trademarks, visit Lexmark.com. All other trademarks used herein are the property of their respective owners. © Copyright 2016 Lexmark International, Inc. All rights reserved. Table of Contents Contents 1. OVERVIEW ............................................................................................................... 4 1.1. Purpose ...................................................................................................... 4 1.2. Intended Audience ...................................................................................... 4 1.3. Revision History .......................................................................................... 4 1.4. References ................................................................................................. 4 2. GLOSSARY .............................................................................................................. 6 3. ARCHITECTURE GUIDELINES ............................................................................... 8 3.1. Types of Deployments ................................................................................ 8 3.2. Deployment Models .................................................................................. 10 3.3. Sizing ........................................................................................................ 10 3.4. Tiering ....................................................................................................... 12 3.5. Scalability and Resiliency .......................................................................... 12 3.6. High Availability and Disaster Recovery .................................................... 16 3.7. Platform Security Requirements ................................................................ 19 3.8. Intranet Deployment .................................................................................. 19 3.9. Internet Facing Deployment ...................................................................... 20 3.10. Service Accounts ...................................................................................... 26 4. INSTALLATION BEST PRACTICE......................................................................... 33 4.1. Installation Prerequisites ........................................................................... 33 4.2. Service Accounts ...................................................................................... 36 4.3. Installation Order....................................................................................... 36 4.4. Scripted vs Wizard Installation .................................................................. 38 4.5. Post-Install Configuration .......................................................................... 39 4.6. Installation Validation ................................................................................ 39 4.7. IIS Configuration ....................................................................................... 40 4.8. Transformation Server Caching ................................................................ 42 5. APPLICATION SECURITY ..................................................................................... 43 5.1. Identity Management/Access Management............................................... 43 5.2. Design-time Groups vs Run-time Groups .................................................. 43 5.3. User Authentication ................................................................................... 44 5.4. Single Sign-On (SSO) ............................................................................... 44 6. AUDITING AND LOGGING .................................................................................... 47 6.1. Application Audit Log ................................................................................ 47 Kofax TotalAgility – Implementation Best Practice Guide Page 1 6.2. IIS Logging................................................................................................ 48 6.3. Windows Event Logs & Text Logs ............................................................. 48 7. ON-PREMISE MULTI-TENANCY ........................................................................... 49 8. DEVELOPMENT APPROACH ................................................................................ 50 9. TOTALAGILITY FORMS VS CUSTOM FORMS ..................................................... 51 10. MANAGING OR EXCHANGING DATA .................................................................. 51 11. CAPTURE/EXTRACTION BEST PRACTICE ......................................................... 53 11.1. Customer Engagement Considerations ..................................................... 53 11.2. Capture Workshops .................................................................................. 57 11.3. Input Considerations ................................................................................. 58 11.4. Using synchronous activities in the SDK ................................................... 58 11.5. Output Considerations .............................................................................. 59 11.6. Image Processing and VRS ...................................................................... 59 11.7. Use of Folders for captured documents .................................................... 60 11.8. Composite Activity or Individual ................................................................ 60 11.9. Shared or Non-Shared Groups ................................................................. 60 11.10. Formatting Rules....................................................................................... 61 11.11. Validation Rules ........................................................................................ 61 11.12. Skipping Document Review ...................................................................... 61 11.13. Skipping Validation ................................................................................... 62 11.14. PDF Conversion ....................................................................................... 62 11.15. Deletion .................................................................................................... 63 11.16. Backing up your Transformation Project ................................................... 63 11.17. Deployment Considerations ...................................................................... 63 12. PROCESS MODELLING BEST PRACTICE ........................................................... 64 12.1. Business versus System Exceptions ......................................................... 64 12.2. Exceptions and Triggers ........................................................................... 65 12.3. Activity Notification .................................................................................... 67 12.4. Use of (.NET) Script Nodes ....................................................................... 68 12.5. Use of Activity Types and System Variables ............................................. 69 12.6. Variable Naming ....................................................................................... 70 12.7. Process Commenting ................................................................................ 71 13. WORK PRIORITISATION ....................................................................................... 71 13.1. Workqueue Interaction .............................................................................. 71 13.2. Work Assignment ...................................................................................... 72 13.3. Job/Activity Due Date and Priority ............................................................. 72 14. CONFIGURATION MANAGEMENT ....................................................................... 74 Kofax TotalAgility – Implementation Best Practice Guide Page 2 14.1. Project Structure ....................................................................................... 74 14.2. QA Testing ................................................................................................ 74 15. RELEASE MANAGEMENT..................................................................................... 75 16. PERFORMANCE TESTING .................................................................................... 76 17. COMPONENT STARTUP/SHUTDOWN PROCEDURES ........................................ 76 18. PROGRAMMING AGAINST THE TOTALAGILITY SDK ........................................ 78 19. HOUSEKEEPING AND SYSTEM MAINTENANCE ................................................ 79 19.1. Maintaining Finished Jobs and the Audit Log ............................................ 79 19.2. Document Storage and Retention ............................................................. 79 20. UPGRADE STRATEGIES ......................................................................................