Home

Welcome to the Alfresco Process Services (APS) SDK Wiki

The Alfresco Process Services SDK (APS SDK) is an enterprise development acceleration kit for building, extending, testing, and deploying custom solutions on Alfresco Process Services (powered by Activiti).

The SDK standardizes developer workflows by providing embedded test runtimes, Dockerized multi-container environments, automated packaging (JAR, WAR overlays, and container images), and full support for both x86_64 and ARM64 (Apple Silicon) architectures.

---

Key Capabilities

• Native Multi-Architecture Support: Full support for ARM64 CPUs (Apple Silicon M1/M2/M3/M4) as well as x86_64, using dedicated Dockerfiles and automatic Maven profile resolution.
• Consistent Local Architecture: Multi-container Docker environment mirroring production topologies (Alfresco Process Services, Activiti Admin, PostgreSQL, and ElasticSearch).
• Storage Persistence: Dedicated persistent Docker volumes for the database (aps-db-volume), contentstore attachments (aps-contentstore-volume), and search index (aps-es-volume).
• Dual Execution Modes: Flexible operations via intuitive terminal run scripts (./run.sh / run.bat) or direct Maven lifecycles (mvn clean install docker:build docker:start).
• Comprehensive Testing Pipeline: Embedded in-memory H2 test runtime for fast unit tests, coupled with an integration test suite driven by a generated Swagger/OpenAPI Java client.
• Remote Debugging: Out-of-the-box JDWP remote debugging over port 5005.

---

🌿 Project Branches & APS Version Compatibility

The APS SDK repository maintains dedicated branches corresponding to each major generation of Alfresco Process Services, providing continuous support for legacy environments as well as modern enterprise deployments:

Project Branch	SDK Version	APS Generation	Supported APS Versions	Supported Java	Branch Status
3.x (current)	APS SDK 3.x	Modern APS	APS 24.1.0 up to APS 26.2.0	Java 17, Java 21	Active (Latest)
2.x	APS SDK 2.x	Legacy APS 2.x	APS 2.0.0 up to APS 2.4.5	Java 11, Java 17	Maintenance (Legacy)
master	APS SDK 1.x	Legacy APS 1.x	APS 1.9.0.5 up to APS 1.11.5	Java 8, Java 11	Maintenance (Legacy)

Working with legacy APS?

• For APS 2.x (APS 2.0.0 through 2.4.5), checkout the 2.x branch.
• For APS 1.x (APS 1.9.0.5 through 1.11.5), checkout the master branch.
• For all modern APS releases (APS 24.1.0 up to 26.2.0+), use the 3.x branch or bootstrap your project with the Maven Archetype.

---

Wiki Documentation Index

Explore the detailed guides below:

1. Getting Started & Prerequisites
   System requirements (JDK, Maven, Docker), Alfresco Nexus credential setup in settings.xml, and license file configuration.

2. Maven Project Archetype
   Bootstrap a new APS SDK project in seconds using the official aps-project-archetype, publicly available on Maven Central (io.github.alfresco-aps-sdk:aps-project-archetype:3.1.3).

3. Project Architecture & Modules
   Detailed breakdown of the Maven submodules: aps-extensions-jar, activiti-app-overlay-war, activiti-app-overlay-docker, and activiti-app-integration-tests.

4. Development & Extension Guide
   Conventions and recipes for Java delegates, task/execution listeners, custom REST endpoints, Spring service beans, and security whitelisting.

5. Running & Deployment
   Command reference for ./run.sh / run.bat and the full Maven build and deployment lifecycle.

6. Docker & Environment Configuration
   Container networking, port mappings, persistent volumes, remote debugging, and configuration overrides.

7. Testing Guide
   Running embedded unit tests with H2 and orchestrating integration tests against live Docker containers.

8. Supported APS Versions & Maven Profiles
   Comprehensive compatibility matrix covering modern APS 24.1.0 through 26.2.0, legacy APS 1.x and APS 2.x branches, dependency alignments, and active profile switching.

---

Legacy & Upgrade Guides

• Adding License Management to Legacy Projects (earlier than 2.0.9 or 1.7.4)
• Upgrading APS SDK 2.x to Support APS 2.2.0 (earlier than 2.0.8)

---

Contributors & Support

• Maintainer: Piergiorgio Lucidi (piergiorgio@apache.org)
• Contributors: Jeff Potts, Luca Stancapiano, Bindu Wavell, Stanley Arnold
• Enterprise Support: Community-led initiative with enterprise maintenance and consulting options delivered by TAI Solutions.