a perpendicular cylinder breaking up into puzzle pieces
On-Deploy Scripts – an ACS AEM Commons Utility


Developers need to perform certain tasks during deployment to AEM server. Component reauthoring is one of the major tasks for a developer making changes to existing components. In this article, we’ll talk about using on-deploy scripts to simplify reauthoring tasks in AEM.

Problem Statement:

If the component is to be configured on one or two pages, then reauthoring is simple. However, if the component needs to be configured on many pages, then it’s tedious for an author to reauthor the same component on every page.

This is one of the scenarios in which we can use on-deploy script. Here is a list of problems we will try to solve.

What Problems are We Trying to Solve?

  • Running ad-hoc script manually
  • Update the content without reauthoring
  • Admin update that needs to do on all server
  • Mass content updates
  • One-time content creation
  • Removing obsolete content
  • Deleting all nodes of a particular resource type

Available Methodology to Solve the Above Problems

  1. Using Servlet
  2. Using Ad-hoc scripts

Issues with Servlet or Ad-hoc Scripts

  • Security Risk
  • Password Expose
  • Anyone can execute
  • Server remains in broken state till we run Ad-hoc script or if it fails
  • Making sure you run scripts on deployment else existing functionality breaks
  • Keeping track of scripts that have been run becomes difficult

ACS AEM Commons provides a useful utility called “On-Deploy Scripts,” which help developers create one-time scripts that execute upon deployment to an AEM server. This feature is available for v3.15.0 and higher versions of ACS-AEM Commons.

So, to overcome this problem we can use On-Deploy Scripts.

Advantages of On-Deploy Scripts:

On-Deploy Scripts allows developers to create one-time scripts that execute upon deployment to an AEM server. Some advantages of this one-time script creation feature are given below.

  • Fully automated
  • Continuous integration gives you automatic testing on Pre-prod
  • Scripts execute along with deployment – more broken state
  • Automation removes chances for error
  • Script status is preserved to be validated later
  • Available with version v3.15.0

How To use:

  1. Install v3.15.0 or higher version ACS-AEM Commons
  2. Enable on-deploy script feature
    • Create OSGi configuration


<?xml version="1.0" encoding="UTF-8"?>
 <jcr:root xmlns:sling=""
 xmlns:jcr=""  jcr:primaryType="sling:OsgiConfig"/>
  1. Implement Script Provider Service
    • Override the getScripts () method.
@Component(immediate = true, service= OnDeployScriptProvider.class, property = { "name =service.description", "value =Developer service that identifies code scripts to execute upon deployment"})
public class OnDeployScriptProviderImpl implements OnDeployScriptProvider {
    public List<OnDeployScript> getScripts() {
        return Arrays.asList(
                // Add Script instances here e.g. new Script1(), new Script2(), new Script3()
  1. Create Script and Add Script Provider
    • Override execute () method
public class ScriptUpdateProperty extends OnDeployScriptBase implements OnDeployScript {
    protected void execute() throws Exception {
        Node nodeUpdate = getOrCreateNode("content/we-retail/us/en/onDeployePage/jcr:content","cq:Page','cq:PageContent");
  1. Make sure acs-commons-on-deploy-scripts-service user has all necessary permissions
  2. Just install the package
  3. Check status at /var/acs-commons/on-deploy-script-status on crxde.


A working demo present on bitbucket

Read our article about another ACS AEM Commons Utility, Ensure Service User

Share it:

Argil DX Media

August 5, 2019

Leave a Comment

Related Posts