Fork me on GitHub

Installing Hippo Content EXIM (Export / Import)

Add Dependencies

Make sure you have the forge Maven2 repository reference and dependency definition in the root pom.xml of your project.

    <repositories>

      <!-- SNIP -->

      <repository>
        <id>hippo-maven2</id>
        <name>Hippo Maven 2 Repository</name>
        <url>https://maven.onehippo.com/maven2-forge//</url>
      </repository>

      <!-- SNIP -->

    </repositories>

    <!-- SNIP -->

    <dependencyManagement>

      <!-- SNIP -->

      <dependencies>

        <!-- SNIP -->

        <!-- NOTE: You should set a property named 'forge.content-exim.version' to a version of this plugin! -->

        <dependency>
          <groupId>org.onehippo.forge.content-exim</groupId>
          <artifactId>content-exim-core</artifactId>
          <version>${forge.content-exim.version}</version>
        </dependency>

        <!--
          The following is optional: Include this when you want to use the built-in REST Services.
          And, this built-in REST Service module can be activated only in the authoring module application. e.g, /cms.
        -->
        <dependency>
          <groupId>org.onehippo.forge.content-exim</groupId>
          <artifactId>content-exim-repository-jaxrs</artifactId>
          <version>${forge.content-exim.version}</version>
        </dependency>

        <!-- The following is optional: Include this only when you want to bootstrap example groovy updater scripts. -->
        <dependency>
          <groupId>org.onehippo.forge.content-exim</groupId>
          <artifactId>content-exim-updater-examples</artifactId>
          <version>${forge.content-exim.version}</version>
        </dependency>

        <!-- SNIP -->

      </dependencies>

      <!-- SNIP -->

    </dependencyManagement>
    

And add the following dependencies to your application subproject. That is, In either cms-dependencies/pom.xml in Hippo CMS v13 or cms/pom.xml in the earlier versions.

    <dependencies>

      <!-- SNIP -->

      <dependency>
        <groupId>org.onehippo.forge.content-exim</groupId>
        <artifactId>content-exim-core</artifactId>
      </dependency>

      <!--
        The following is optional: Include this when you want to use the built-in REST Services.
        And, this built-in REST Service module can be activated only in the authoring module application. e.g, /cms.
      -->
      <dependency>
        <groupId>org.onehippo.forge.content-exim</groupId>
        <artifactId>content-exim-repository-jaxrs</artifactId>
      </dependency>

      <!-- The following is optional: Include this in CMS application module only when you want to bootstrap example groovy updater scripts. -->
      <dependency>
        <groupId>org.onehippo.forge.content-exim</groupId>
        <artifactId>content-exim-updater-examples</artifactId>
      </dependency>

      <!-- SNIP -->

    </dependencies>
    

Now, you're ready to use the plugin!

Optional Dependencies with Apache Commons VFS Library

Some Groovy script examples in some documentation pages (e.g, Tutorials - Importing Documents) use Apache Commons VFS library.

If you want to use other File Systems other than Local Files, please make sure you add necessary optional dependencies additionally as Apache Commons VFS library doesn't include those optional depencencies by default. See the following for those optional dependnecies: