How To Use Maven to Install Schema App's AEM Connector

Modified on Thu, 8 Aug at 12:43 PM

The Schema App AEM Connector can be installed as a dependency in Maven.


TABLE OF CONTENTS


Download the latest version of the Schema App Connector on Maven

You can find all versions of the Schema App Connector on Maven here. We always recommend installing the latest version. 


A screenshot of all the versions of the Schema App Connector for AEM on Maven


We recently released version 2.0 of the Schema App Connector for AEM, as shown in the screenshot above. This is the version you would replace [version_number] with when adding the dependency.  


Modifying POM Files to Install the Connector

To install the Connector, you will need to modify three pom.xml files and the filter.xml file. This will install the core and UI of the Connector on your AEM system and enable our scheduler to update your markup.


When installing the Connector, ensure the file type is a zip file and NOT a pom file. Only zip installations are supported. 


1. Within all/pom.xml

Under the <build>/<plugins>/<plugin> section, add the following. 


If the “org.apache.jackrabbit” plugin is already added to your pom, you can simply copy and paste the embedded section from the snippet below. Be sure to adjust the target based on your application and note this target for future steps.

<build>
<plugins>
<plugin>
<groupId>org.apache.jackrabbit</groupId>
<artifactId>filevault-package-maven-plugin</artifactId>
<extensions>true</extensions>
<configuration>
<embedded>
<groupId>com.schemaapp</groupId>
<artifactId>schemaapp.all</artifactId>
<type>zip</type>
<filter>true</filter>
<!-- Adjust this target based on your application and save this value -->
<target>/apps/schemaappsite-connector/application/install</target>
</embedded>
</configuration>
</plugin>
</plugins>
</build>


Within the dependencies section of the all/pom.xml add the following:

<dependency>
<groupId>com.schemaapp</groupId>
<artifactId>schemaapp.all</artifactId>
<type>zip</type>
</dependency>


2. Modify the filter.xml file.

In  the <Project directory>/all/src/main/content/META-INF/vault/filter.xml file,  add a new filter root.

  1. Open the filter.xml file.
  2. Add new line using the target path set in the first step: <filter root="<replace it with your target path>"/>

3. Changes in ui.apps/pom.xml

Add the following to the <dependencies> section:

<dependency>
<groupId>com.schemaapp</groupId>
<artifactId>schemaapp.all</artifactId>
<type>zip</type>
</dependency>

4. With the base level pom.xml


Add the following under the dependencies section:

<dependency>
<groupId>com.schemaapp</groupId>
<artifactId>schemaapp.all</artifactId>
<version>[version_number]</version>
<type>zip</type>
</dependency>

The Schema App team releases new features and bug fixes for the Connector regularly, so be sure to keep an eye out for any communications from our team to keep your Connector up to date. 


How to Set Up the Schema App Connector on AEM


Step 1: Select Your Deployment Type in Schema App

Note: A project on Schema App consists of a group of URLs. Every site on AEM should have a configuration that is linked to a project on Schema App (i.e. one configuration for every AEM site).


  1. Login to Schema App, select the appropriate project and click the dropdown to access the settings.
  2. Click "Add Website" and enter the base URL / Domain of your AEM website.
  3. Under Deployment Settings, select Adobe Experience Manager.
  4. In the Deployment Settings dropdown, copy the API Key and Account ID to your clipboard. You will need this information for registration on AEM. 



Step 2: Set up the Schema App Connector Configuration on AEM

  1. Log in to Adobe Experience Manager.
  2. Click on ‘Tools’ in the right menu bar.
  3.   Select the 'Cloud Services' and then select the "Schema App Connector" tile.
     


  4.     Click on the ‘Create’ button on the top right.
     
     


  5. In the dialog box, enter your Account ID, API key and website URL (publisher), and select your deployment method of choice (JavaScript or Crawler). The deployment method you choose here should match your Highlighter deployment in Schema App.

    When you're done entering the information, click 'Connect to Schema App' to register the site.
     
  6. If you've done everything accordingly, you should see a message indicating that your site has been registered with Schema App. From there, click 'Save' in the top right corner of the page.  

     


  7. Your new configuration will now be listed on the left menu bar of the screen.
     

Now that you've set up the Schema App configuration on AEM, the next step would be to apply it to the required pages on your AEM site. 

Step 3: Apply Schema App Configuration to your pages


  1. Go to your AEM home page.
  2. Click on ‘Sites’.
     
  3. Select the site that you want the configuration earlier created to apply to.

    Graphical user interface, application Description automatically generated 
  4. On the top menu bar, click ‘Properties’.
  5. Click on the ‘Cloud Services’ tab.
    Graphical user interface, text, application, email Description automatically generated

     

     
  6. Select the appropriate configuration created earlier in the drop-down menu.
  7. Click Save and Close.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article