Hyland Alfresco Developer - Software Development Kits (SDKs)

Name: Hyland Alfresco Developer - Software Development Kits (SDKs)
Rating: 3.9 (7 reviews)

In depth look at Alfresco SDK 4.x (In-Process) and Alfresco SDK 5.x (Out-of-Process)

Created byMartin Bergljung

Last updated 3/2024

English

English [Auto],

What you'll learn

What Alfresco In-Process SDK 4.x is used for
What Alfresco Out-of-Process SDK 5.x is used for
How to generate Alfresco extension projects based on templates
How to organize Alfresco projects for bigger teams
How to create out-of-process Spring Boot applications integrating with Alfresco Content Services Repository
How to store Alfresco extension artifacts (JARs, Docker Images) in Nexus
How to build Alfresco extension artifacts (JARs, Docker Images) with Jenkins CI server
How to inspect an extension and make sure it does not break best practices
About the unofficial Alfresco Process Services SDK

Course content

12 sections • 82 lectures • 16h 52m total length

Introduction7:58
Explore Alfresco SDKs, from in-process sdk four to out-of-process sdk five, with extension inspector, nexus repository manager, and Jenkins CI for multi-developer projects, including process services and docker images.

Introduction1:09
Explore Apache Maven as the base build tool for the Alfresco platform and its SDK, and learn to build extensions, manage POM files, dependencies, and archetypes.
What is Maven and how does it work?19:25
Maven Multi Module Projects5:48
Learn to configure a Maven multi-module project by defining a parent pom with modules, structuring submodules, and using mvn install to ensure proper reactor build and local repository updates.
Maven Archetypes2:42
Explore maven archetypes to standardize alfresco sdk projects with parameterized templates. Generate projects via mvn archetype generate, selecting templates like quickstart or web app and setting groupId, artifactId, and version.

Generate a project based on a Maven archetype9:59
In this lecture we generate a Maven-based build project based on an out-of-the-box Maven archetype (i.e. project template). It is time to put the Maven theory into practice.
Adding Spring Beans to the project16:01
In this lecture we do a bit of coding to see how we can create some beans and wire them together with Spring. It is time to put the Spring Framework theory into practice.

Introduction13:56
Explore Alfresco's in-process SDK, its platform and share extensions, and the all-in-one project, with Maven templates, Docker packaging, and compatibility notes for Java and Alfresco versions.
Alfresco Artifacts Repository4:24
In this lecture we look at the Alfresco Nexus Repository where all the Alfresco artifacts (i.e. JARs etc) are stored that we define as dependencies in the extension projects.
Maven Central Artifacts Repository3:03
The extension projects are created from Alfresco Maven Archetypes (i.e. project templates). They need to be downloaded from somewhere. The Maven Central Artifacts Repository is the place.
Extension module types (JARs and AMPs)9:03
When building Alfresco customisations they are shipped as a JAR or a so-called AMP. This lecture explains the difference between these artifact types and when to use them.
All-In-One (AIO) Project - How to generate and build26:05
Generate an all-in-one SDK project with Maven by filtering alfresco templates and selecting the all-in-one archetype, using the specified SDK and JDK versions.
All-In-One (AIO) Project - Platform / Repository extension module introduction13:41
Explore the all-in-one Alfresco platform module, its module id and properties, archetype-driven structure, and how it wires with spring, content models, bootstrapping, and the rest API.
All-In-One (AIO) Project - Custom Docker Image for Platform / Repository8:40
All-In-One (AIO) Project - Share UI extension module introduction7:36
All-In-One (AIO) Project - Custom Docker Image for Share UI3:20
All-In-One (AIO) Project - Docker Compose runner11:07
Run alfresco content services extensions with docker compose, building custom repository, content services, and share images. Access localhost:8080 to verify modules via module browser and monitor logs.
All-In-One (AIO) Project - Sample code introduction12:41
Explore the all-in-one project sample code, including server-side web scripts and share UI widgets, showing how to run, configure, and assemble module extensions with a local Nexus repo for Alfresco.
All-In-One (AIO) Project - Sample Content Model introduction11:51
All-In-One (AIO) Project - Debugging Java5:08
Debug java remotely in the alfresco sdk by configuring a remote jvm in intellij, using docker-based setup and port 888/9898 to step through web scripts and models.
All-In-One (AIO) Project - Unit testing7:24
All-In-One (AIO) Project - Integration testing16:08
All-In-One (AIO) Project - Stopping and cleaning up5:40
Platform / Repository JAR Project - Generating and building17:32
In this lecture you will learn how to generate a Platform JAR Module project.
Share UI JAR Project - Generating and building10:34
In this lecture you will learn how to generate a Share UI JAR Module project.
Share UI JAR Project fix0:17
Using AMPs - Working with Alfresco Module Packages (AMPs)31:29
This lecture provides a practical example of when to use AMPs.
Using an Enterprise version52:38

Introduction10:48
Explore Alfresco's extension inspector, a runnable jar that analyzes server-side extensions against a chosen Alfresco version using inventories to detect file and spring bean overrides and classpath conflicts.
Analysing Platform / Repository JAR extensions9:39
Analyze platform repository jar extensions with the extension inspector, building jars via Maven, comparing the inventory against Alfresco versions, and identifying conflicts and logging details.
Generating an Inventory file for non-included Alfresco version7:19
Use the extension inspector to generate an inventory JSON for a non-included Alfresco version. Obtain community distribution war from Nexus, build the inventory, and run the inspector on extensions.

Using a standard All-in-One (AIO) project for all code6:59
Using stand-alone JAR/AMP projects and an Aggregator All-in-One (AIO) project9:24
Explore using stand-alone jar/amp projects with an aggregator all-in-one to manage multi-developer Alfresco SDKs, versioning, Docker image builds, and release workflows via GitHub, Nexus, and Jenkins.
Creating an SDK Parent POM project for common configuration13:28
Introducing and running Nexus Repository Manager as Artifact Repository16:57
To be able to replicate a "real" content management project we should set up a remote maven repository where we can store and version the artifacts, such as JARs, for our project. This is similar to how Alfresco has its own Maven Repository at artifacts.alfresco.com.
Deploy a SNAPSHOT version of the SDK Parent POM to Nexus16:02
Deploy a Release version of the SDK Parent POM to Nexus and tag in GitHub22:50
Using the SDK Parent POM from an extension project22:42
Updating the SDK Parent POM so projects are runnable21:14
Update the sdk parent pom to activate resources and docker related plugins, enabling runnable content model extensions, local testing with snapshots, and streamlined tagging and releasing.
Creating an All-In-One (AIO) Aggregator Project23:25
In this lecture we will create an AIO project and clean it up making it ready to be used as an aggregator project. It will pull in other modules (platform, share, utils etc) from the local nexus and build the final artifact.
Updating the SDK Parent POM to clean up build, running and integration tests35:00
Refactor Content Model platform extension and add ReST API platform extension28:19
Learn to refactor an Alfresco content model into a dedicated rest API platform extension, separating web script logic and coordinating releases via a git and mvn-based aggregator workflow.
Add a Share UI Extension to the AIO Aggregator Project25:40

Storing custom Alfresco Docker Images in Nexus14:28
Building custom Alfresco Platform and Share Docker Images23:17
Introducing and running Jenkins Build Server (CI)16:47
Checkout All-In-One Aggregator project from GitHub and build with Jenkins11:17
Let's see how we can create a Jenkins Pipeline that does a git clone on the Aggregator project and then builds the Docker Images.
Publish custom Platform and Share Docker Images to Nexus with Jenkins12:00
Push docker images from a Jenkins pipeline to a Nexus private registry, tag with version, and publish platform and share images for staging and production.

Introduction2:41
All-In-One (AIO) Project SDK 3.0 - How to generate, introduction, and structure15:09
This project template is called All-in-One as it contains everything you need to develop and test Platform/Repository and Share customisations. In this lecture we show how to generate a project based on this template and explain the structure of the project. It's for ACS 5.2 and uses SDK 3.0
All-In-One (AIO) Project SDK 3.0 - Platform / Repository extension module intro10:41
In this lecture we look at the structure of a Platform JAR module. The structure is also applicable to Platform AMPs. For ACS 5.2 and SDK 3.0
All-In-One (AIO) Project SDK 3.0 - Share UI extension module introduction9:39
In this lecture we look at the structure of a Share JAR module. The structure is also applicable to Share AMPs. For ACS 5.2 and SDK 3.0
All-In-One (AIO) Project SDK 3.0 - Configure14:05
Here we look at some of the more significant properties that can be configured for an AIO project. For ACS 5.2 and SDK 3.0
All-In-One (AIO) Project SDK 3.0 - Configure Alfresco version3:14
This lecture looks at how you can make sure you develop and run against the Alfresco version that you will be using in production.
All-In-One (AIO) Project SDK 3.0 - Build3:22
Lecture showing how to compile, test, package, and install an AIO project. For ACS 5.2 and SDK 3.0
All-In-One (AIO) Project SDK 3.0 - Run15:38
In this lecture we have a look at how the Alfresco Maven Plugin can be used to run the Alfresco server with the customisations applied (i.e. alfresco:run). There is no need to do a separate full Alfresco installation. For ACS 5.2 and SDK 3.0
All-In-One (AIO) Project SDK 3.0 - Sample code5:32
The AIO project comes with a number of sample code extensions, both for the platform application (alfresco.war) in the form of a custom REST API (called Web Script in Alfresco lingo), and the UI (share.war) in the form of a custom Share Page (called Aikau Page in Alfresco lingo). We look at how to try them out in this lecture. For ACS 5.2 and SDK 3.0
All-In-One (AIO) Project SDK 3.0 - Sample Content Model4:36
In this lecture we look at the sample content model that comes with the AIO project. A domain specific content model is fundamental to any content management project, and this sample content model gives you a head start on how to implement one. For ACS 5.2 and SDK 3.0
All-In-One (AIO) Project SDK 3.0 - Debugging Java6:32
Shows how to start the Alfresco server via the Alfresco Maven Plugin so it is ready for debugging of Java code. For ACS 5.2 and SDK 3.0
All-In-One (AIO) Project SDK 3.0 - Integration testing introduction18:35
Alfresco SDK 3 includes a new module for integration testing, and a number of example integration tests. This lecture introduces this module and the sample tests.
Platform / Repository JAR Project SDK 3 - How to generate, intro, and structure17:49
This lecture shows you the extension project that is used when you only develop customisations for the platform/repository (i.e. the alfresco.war). For ACS 5.2 and SDK 3.0
Share UI JAR Project SDK 3.0 - How to generate, intro, and structure10:25
This lecture shows you the extension project that is used when you only develop customisations for the Share UI (i.e. the share.war). For ACS 5.2 and SDK 3.0
Hot Reloading Code with HotSwap - Intro and Setup12:14
In this lecture we introduce and set up hot-reloading with the open source HotSwap agent.
Hot Reloading Code with HotSwap - Platform / Repository extension modules8:36
This lecture shows how to use the HotSwap agent to do hot-reloading of classes and resources for Platform/Repository extensions (i.e. customisations applied to alfresco.war). Enabling Rapid Application Development (RAD). HotSwap is an open source alternative to JRebel.
Hot Reloading Code with HotSwap - Share UI extension modules7:34
This lecture shows how to use the HotSwap agent to do hot-reloading of classes and resources for Share UI extensions (i.e. customisations applied to share.war). Enabling Rapid Application Development (RAD). HotSwap is an open source alternative to JRebel.
AMPs with SDK 3.0 - Introduction15:19
Compare Alfresco amps and jars, explain when to use amps vs jars, and describe installation, overwriting web resources (such as favicon), and dependency management in an all-in-one or standalone module.
AMPs with SDK 3.0 - Working with Alfresco Module Packages (AMPs)13:45
Demonstrates when to use alfresco module packages (amps) to deliver non-provided libraries, override web resources, and build platform jars with maven assembly for alfresco deployments.

Requirements

Basic Docker and Docker Compose knowledge
Java (Beginners level)

Description

Developing extensions for Hyland Alfresco Content Management systems can be daunting at first. But if you spend some time getting to know the Software Development Kits (SDKs) available to aid you in developing extensions, then the development journey will be much more pleasant.

There are mainly two development kits available:

* The traditional In-Process SDK 4.x. This SDK has existed since the beginning of Alfresco and has evolved several times. We cover it in detail and even look at an earlier version, 3.x, when containers weren't common practice.

* The new Out-of-Process SDK 5.x. This SDK follows newer best practices of keeping your extensions outside the Alfresco application, enabling easier upgrades of Alfresco and independent development, deployment, and scaling of your extensions.

Larger development projects involving multiple developers usually require some infrastructure, such as Artifacts Repository and CI server, to be considered. We look at how you can use Nexus Repository manager to store stand-alone extensions and how to build them with Jenkins CI Server.

This course is mostly about Alfresco Content Services (ACS) development and the officially supported SDKs. But we will also look at an unofficial SDK for developing extensions for Alfresco Process Services (APS), just so you know it exists.

“Hyland Alfresco Developer - Software Development Kits (SDKs)” is an independently developed course by Martin Bergljung and has not been created, endorsed, or verified by Hyland Software, Inc.. Hyland Software, Inc. shall not have any liability with respect to the “Hyland Alfresco Developer - Software Development Kits (SDKs)” course offered by Martin Bergljung.

Who this course is for:

Alfresco Developers
Alfresco Architects
Alfresco Project Managers

Hyland Alfresco Developer - Software Development Kits (SDKs)

What you'll learn

Explore related topics

Course content

Introduction1 lecture • 8min

Spring Framework6 lectures • 42min

Introduction to the Apache Maven Build System4 lectures • 29min

Verifying Java Development Kit (JDK) and Installing Maven3 lectures • 10min

Spring and Maven Project Example2 lectures • 26min

Alfresco In-Process SDK 4.x for Content Services (ACS) 6.x,7.x - Containerised21 lectures • 4hr 32min

Alfresco Extension Inspector for Alfresco In-Process SDK 4.x3 lectures • 28min

Organising an Alfresco In-Process SDK project and publish Extensions to Nexus12 lectures • 4hr 2min

Publishing custom Alfresco Docker Images to Nexus with Jenkins5 lectures • 1hr 18min

Alfresco In-Process SDK 3 for Alfresco Content Services (ACS) 5.2- NO Containers19 lectures • 3hr 15min

Requirements

Description

Who this course is for: