Install Schema App's AEM Connector through Maven

Modified on Mon, 06 May 2024 at 12:11 PM

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


Schema App Connector Versions

We always recommend installing the latest version. You can find all versions through: 

You will see something like the following when you navigate to that page:

The latest version in this screenshot would be 1.4.6 so that is the version you would replace [version_number] with when adding the dependency. Please use the link above to get the latest version as we are making updates and improvements to the connector frequently.

Modifying POM Files to Install the Connector

 There are three pom files you need to modify to install this connector and a modification to the filter.xml file. When installing the plugin make sure the type is always zip and not pom. Only zip installation is supported. 

1. With in all/pom.xml

Under the <build>/<plugins>/<plugin> section add the following. If “org.apache.jackrabbit” plugin is already added in your pom then just copy and paste the embedded section from below snippet, be sure to adjust the target based on your application and note this target for future steps.

<!-- Adjust this target based on your application and save this value -->

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


2. Modify the filter.xml file.

 In  <Project directory>/all/src/main/content/META-INF/vault/filter.xml file 

Add a new filter root.

1. Open 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

In the <dependencies> section add the following:


4. With the base level pom.xml

Add the following under the dependencies section


Schema App does release new features and bug fixes so be sure to check correspondence from us and update your connector version to benefit from our latest changes. 

Setting up the Connector

Step 1: Select 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. These will be required for registration on AEM.

Step 2: Schema App Connector Configuration 

        1. Login to Adobe Experience Manager. (if not logged in).

        2. Click on ‘Tools’ in the right menu bar.

      3. Click on Cloud Services and then Click on " Schema App Connector" tile.

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

    5. In the dialog box, Enter the Account ID, API key & Website URL (publisher). Also determine whether you want to deploy with JavaScript or the Crawler, this should match your Highlighter deployment in Schema App. When finished click 'Connect to Schema App' to register the site.

    6. You should get a message "You site has been registered with Schema App'.
        Click 'Save' in top right corner of the page.

   7. New config should be listed on the left of the screen.

The next steps guide you on how to configure the Schema App Configuration to the required pages.

  8. Go back to the Home page of your Adobe Experience Manager.

  9. Click on ‘Sites’.

 10. Select the site that you want the configuration earlier created to apply to.

Graphical user interface, application Description automatically generated

 11. On the top menu bar, click ‘Properties’.

 12. Then Click on ‘Cloud Services’ tab

Graphical user interface, text, application, email Description automatically generated

  13. Select the appropriate configuration created earlier in the drop down.

   14. 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 atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article