Setup Guide zapAnalytics with Docker
Detailed guide to prepare the use of zapAnalytics with Docker
General Information about zapAnalytics
zapAnalytics is a web application based on Java Spring. 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 OpenJDK (Open Java Development Kit). It is open source, so you do not need to purchase or maintain a separate Java license.
Requirements
zapAnalytics and the postgreSQL database are deployed via Docker, running on a virtual machine or server. The hardware specifications depend on the data volume extracted.
-
-
Set up virtual machine or server fulfilling minimum requirements: Setup Guide Virtual Machine / Server
-
Prepare and install Docker Desktop: 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
-
Make sure that ports in the internal network for SAP (3300, 3600, 3299) and web access from client computers (9007) are be allowed through the firewall
-
You may set up Remote Desktop (RDP) access for the audit manager and optionally the auditors
-
Important note: 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: Do not install in C:\Program Files as it is usually set to read-only. This will cause problems when using zapAnalytics.
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. Your IT-Admin can replace the certificate during onboarding with zapliance. (e.g. .cert, .pem)
Alternatively, you can use nginx or similar proxy servers to set up HTTPS for your zapAnalytics.