ACTICO Platform - Workplace Operations Guide Version 3.8.0-R107 ACTICO GmbH Operations Guide ACTICO GmbH Copyright © 2019 ACTICO GmbH © ACTICO GmbH. All rights reserved, also regarding any disposal, exploitation, reproduction, editing, distribution, as well as in the event of applications for industrial property rights. Operations Guide Table of Contents Introduction ................................................................................................................................... vi 1. Audience .................................................................................................................................... vi 2. Content ...................................................................................................................................... vi 1. Overview ..................................................................................................................................... 1 1.1. High Level Deployment Diagram ................................................................................................... 1 1.2. Runtime Environment Deployment View ......................................................................................... 2 2. Installation .................................................................................................................................. 3 2.1. Installation of ACTICO Workplace Web Application ........................................................................... 3 2.1.1. Installation of Database ............................................................................................................ 3 2.1.1.1. MySQL required Server System Variables ................................................................................... 3 2.1.2. Execution as standalone application ........................................................................................... 3 2.1.2.1. Installation ........................................................................................................................... 3 2.1.2.2. License File .......................................................................................................................... 4 2.1.2.3. Logging ................................................................................................................................ 4 2.1.2.4. Configuration ........................................................................................................................ 4 2.1.2.5. Operating System Service Integration ....................................................................................... 4 2.1.2.6. Execution ............................................................................................................................. 4 2.1.2.7. Shutdown ............................................................................................................................. 4 2.1.2.8. Embedded Webserver ............................................................................................................. 5 2.1.3. Execution within an application server ........................................................................................ 5 2.1.4. Connection Pool Configuration ................................................................................................... 5 2.1.5. Cluster Setup .......................................................................................................................... 6 2.1.6. Search Index Location .............................................................................................................. 6 2.1.7. Security .................................................................................................................................. 6 2.1.8. Authentication and Authorization ............................................................................................... 6 2.1.8.1. Embedded Authentication ....................................................................................................... 7 2.1.8.2. LDAP and Active Directory Authentication .................................................................................. 7 2.1.8.3. LDAP Synchronization ............................................................................................................. 7 2.1.8.4. Remote API Authentication ..................................................................................................... 9 2.1.8.5. Spring Boot Actuator Web API Authentication ............................................................................. 9 2.1.9. Add-ons ................................................................................................................................. 9 2.1.9.1. Add-on Folder Structure ........................................................................................................ 10 2.1.9.2. Add-on Configuration ............................................................................................................ 11 2.1.10. Other ................................................................................................................................... 11 2.1.10.1. Browser-Based Spell Checking ............................................................................................... 11 2.2. Installation of ACTICO Workplace Batch Application ....................................................................... 12 2.2.1. Installation ............................................................................................................................ 12 2.2.2. Logging ................................................................................................................................. 12 2.2.3. Configuration ......................................................................................................................... 12 Copyright © ACTICO GmbH iii Operations Guide 2.2.4. Operating System Service Integration ........................................................................................ 12 2.2.5. Execution .............................................................................................................................. 12 2.2.6. Shutdown .............................................................................................................................. 12 2.2.7. Detailed Configuration ............................................................................................................. 13 2.2.7.1. General Parameters .............................................................................................................. 13 2.2.7.2. Connection Pool Configuration ............................................................................................... 14 2.2.7.3. Spring Batch Job Configuration ............................................................................................... 14 2.2.7.4. Transaction Configuration ...................................................................................................... 14 2.2.7.5. Thread Pool Configuration ..................................................................................................... 14 2.2.8. Starting and Stopping a Scheduler Process as Background Process ................................................ 15 2.2.8.1. Configuration Parameters for the Scheduler ............................................................................. 15 2.3. Installation of ACTICO Workplace Runtime API Maven Artifacts ......................................................... 16 3. Operations and Maintenance ........................................................................................................ 17 3.1. Jobs ........................................................................................................................................ 17 3.1.1. User Maintenance Job .............................................................................................................. 17 3.1.2. Watchdog Job ......................................................................................................................... 17 3.1.3. Stale Locks Removal Job .......................................................................................................... 17 3.1.4. Search Index Commit Job ......................................................................................................... 17 3.2. Logging ................................................................................................................................... 17 3.2.1. Minimizing Log Messages ......................................................................................................... 18 3.2.2. Rules Services, Actions and Functions Exception Interceptor ......................................................... 18 3.2.3. Web Layer ............................................................................................................................. 18 3.2.4. Background Processes ............................................................................................................ 18 3.2.4.1. Quartz Scheduling ................................................................................................................ 18 3.3. Monitoring ............................................................................................................................... 19 3.3.1. Endpoints .............................................................................................................................. 19 3.4.