Setup Guide zapAnalytics with Docker (Linux)
Detailed guide to prepare the use of zapAnalytics with Docker
General Information about zapAnalytics
zapAnalytics is a web application based on Java Spring, which uses Apache Tomcat as application server. SAP data extraction is performed via RFC and requires only a reading SAP user authorized with SAP standard function modules. A postgreSQL database is used as the database, where all data is stored locally.
The duration for data extraction and processing can vary significantly depending on the amount of data, and it may take several days. A stable network connection to the ERP and possibly the target system is required to ensure data flow.
The software uses Adoptium Temurin JDK (Java Development Kit). It is "GNU General Public License, version 2 with the Classpath Exception" licensed and free of charge.
For secure HTTPS communication nginx is used as a proxy server gateway between containers and other (internal or external) networks.
Requirements
zapAnalytics, postgreSQL database and nginx are deployed via Docker, running on a virtual machine or server. The hardware specifications depend on the data volume extracted.
-
Set up Linux-based virtual machine or server fulfilling minimum requirements: Setup Guide Virtual Machine / Server
- Make sure that the required ports for your specific zapHome setup are allowed through the firewall.
-
Prepare and install Docker: Setup Guide Docker
-
Prepare SAP RFC user: Setup Guide SAP
-
For end-user devices, please make sure Power BI Desktop is installed so reports can be created: Setup Guide Power BI
Important: Please make sure that automatic operating system reboots are postponed until intensive data extraction or processing is finished!
Automated reboots during execution cause data loss and unnecessary re-processing.
Installation Process
zapliance will provide you an access token and a docker-compose.yml file during onboarding. The file includes the default configuration for all containers (inlcuding network and hardware allocation). You can use the standard Docker CLI commands to start, stop and update the zapAnalytics Docker image.
The commands are listed in this Knowledge Base article: Basic Docker Commands (CLI)
The process can be conducted in a meeting together with zapliance.
Important: Select a disk partition with enough disk space and make shure that the running process has read and write access to the folder.
Access to zapAnalytics
Once the software is running, users can access the web interface via https://localhost:9007/zapAnalytics/login on the server.
Client computers in the same internal network can access the web interface via the host's IP address (e.g., https://hostIP:9007/zapAnalytics/login).
The software includes a self-signed certificate (.jks), enabling standard HTTPS communication. You can replace the certificate during onboarding with zapliance by replacing the fullchain.pem and privkey.pem/.key files in the /certs folder.