Install Schema App's AEM Connector through Maven

Modified on Mon, 11 Mar 2024 at 05:06 PM

We offer install the connector as a dependency in maven you can find all versions through: https://repo1.maven.org/maven2/com/schemaapp/schemaapp.all/ We always recommend you install the latest version.

You will see something like the following when you 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.

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.

<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>

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>"/>

Changes in ui.apps/pom.xml

In the <dependencies> section add the following:

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

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>

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.

Login to Schema App, select the appropriate project, and click the dropdown to access the settings.
Click "Add Website" and enter the base URL / Domain of your AEM website.
Under Deployment, select Adobe Experience Manager.
Click ‘OK’ to save the selection.
On the side menu bar, navigate to Deployment > Integrations.
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’.