CQ Groovy Console

CITYTECH, Inc.

Overview

The CQ Groovy Console provides an interface for running Groovy scripts in the AEM (Adobe CQ) container. Scripts can be created to manipulate content in the JCR, call OSGi services, or execute arbitrary code using the CQ, Sling, or JCR APIs. After installing the package in AEM (instructions below), see the console page for documentation on the available bindings and methods. Sample scripts are included in the package for reference.

Requirements

• AEM 6.0 running on localhost:4502
• Versions 5.x.x and 6.x.x are compatible with CQ 5.6
• Versions 3.x.x are compatible with CQ 5.4 and 5.5
• Maven 3.x

Installation

1. Install the console package.

   mvn install -P local
   

   or

   mvn install -P local,replicate
   

   The optional replicate profile activates the deployed package to the local publish instance.

2. Verify the installation.

Additional build profiles may be added in the project's pom.xml to support deployment to non-localhost AEM servers.

AEM 6.0 no longer allows vanity paths for pages in /etc by default. To enable access to the Groovy Console from /groovyconsole as in previous versions, the Apache Sling Resource Resolver Factory OSGi configuration must be updated to allow vanity paths from /etc. The Groovy Console Configuration Service can then be updated to enable the vanity path if so desired.

Context Path Support

If you are running AEM with a context path, set the Maven property aem.context.path during installation.

mvn install -P local -Daem.context.path=/context

Notes

Sample scripts can be found in the src/main/scripts directory.

Versioning

Follows Semantic Versioning guidelines.

Issues

Please contact Mark Daugherty with any questions or create an issue here.