Skip to content

Latest commit

 

History

History
49 lines (27 loc) · 2.95 KB

README.md

File metadata and controls

49 lines (27 loc) · 2.95 KB
Raw

AEM Groovy Console

CITYTECH, Inc.

Overview

The AEM 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 AEM, 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.

Screenshot

Requirements

  • AEM 6.1 running on localhost:4502
  • Versions 7.x.x are compatible with AEM 6.0
  • 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. Download the console package. For previous versions, tags can be checked out from GitHub and built directly from the source (e.g. mvn install).

  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

Extensions

Starting in version 7.0.0, the Groovy Console provides extension hooks to further customize script execution. The console exposes an API containing three extension provider interfaces that can be implemented as OSGi services in any bundle deployed to an AEM instance. See the default extension providers in the com.citytechinc.aem.groovy.console.extension.impl package for examples of how a bundle can implement these services to supply additional script bindings, metaclasses, and star imports.

Notifications

To provide custom notifications for script executions, bundles may implement the com.citytechinc.aem.groovy.console.notification.NotificationService interface (see the com.citytechinc.aem.groovy.console.notification.impl.EmailNotificationService class for an example). These services will be dynamically bound by the Groovy Console service and all registered notification services will be called for each script execution.

Notes

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

Versioning

Follows Semantic Versioning guidelines.