Install, Update, or Uninstall Acrolinx for AEMaaCs

What you should know about installing, updating, and uninstalling.

Before You Install

Check our Compatibility Guide if you want to know whether Acrolinx for Adobe Experience Manager as a Cloud Service (AEMaaCS) works with your local platforms.

Before you install, make sure that you have the following:

Adobe AEM as a Cloud Service (AEMaaCS)

Adobe AEMaaCS Versions	Acrolinx for Adobe AEM Versions
	Supported	Maintained	Deprecated	Support for AI Assistant and Suggestions
AEMaaCS Sites	3.0.0	2.3.4	2.3.3 and earlier	2.3.3 and later
AEM Guides 2024.04	3.0.0	2.3.4	2.3.3 and earlier	2.3.3 and later

Install

Notice

You'll need Adobe Experience Manager (AEM) administrator rights to install Acrolinx for AEM.

To use Acrolinx for AEMaacs, you'll need to integrate Acrolinx into your existing code repository.

To install Acrolinx for AEMaaCs, do the following:

Create a clone of your Cloud Manager's Git repository and copy the Acrolinx module from the Acrolinx for AEMaaCS Git repository to the root directory of the cloud manager code.
Update the parent section of /acrolinx/pom.xml with your parent project's pom details and change the artifact Id to match your application's naming convention. For example:
Set the artifactId in /acrolinx/acrolinx.installer/pom.xml per your application's naming conventions.

Add "Acrolinx" as a module under modules in /acrolinx/pom.xml and enter a dependency for the Acrolinx installer in the all module in /acrolinx/pom.xml. For example:

<dependency> 
  <groupId>com.acrolinx.client</groupId> 
  <artifactId>aemaacs-acrolinx-project-acrolinx-installer</artifactId> 
  <version>0.0.1-SNAPSHOT</version> 
  <type>zip</type> 
</dependency>

Insert a section called embedded in the plugin section of the all module within the filevault-package-maven-plugin. For example:

<embeddeds>  
  <embedded>    
    <groupId>com.acrolinx.client</groupId>    
    <artifactId>aemaacs-acrolinx-project-acrolinx-installer</artifactId>    
    <type>zip</type>    
    <target>/apps/wknd-packages/application/install</target> <!-- Adjust path as per your project-->  
  </embedded>
</embeddeds>

Add the following environment variables to the cloud manager environment configuration:

Name

Value

Type

Default

Optional

Notes

ACROLINX_URL

https://<tenant>.acrolinx.cloud

variable

ACROLINX_GENERIC_TOKEN

secret-token

secret

For information on how to get the ACROLINX_GENERIC_TOKEN, visit About Single Sign-On with Acrolinx

ACROLINX_FORWARD_COOKIES

true

false

variable

false

Yes

Update

To update AEMaaCS, change the acrolinx.version property in the properties section of /acrolinx/acrolinx.installer/pom.xml. For example:

   <properties>
<acrolinx.version>2.0.0-SNAPSHOT</acrolinx.version>
<target.path.for.install>${project.build.outputDirectory}/jcr_root/apps/acrolinx-installer     /install</target.path.for.install>  
   </properties>

Uninstall

To uninstall AEMaaCS, do the following:

Remove the Acrolinx module from your cloud project.
Remove the entries added to the parent section of /acrolinx/pom.xml during installation.
Remove the cloud configuration for the Acrolinx URL and the ACROLINX_GENERIC_TOKEN.
Rerun the cloud manager pipeline.

How can we help?

Search