lucapreziati / infoarchive-sip-sdk

Software Development Kit (SDK) for OpenText InfoArchive, facilitating the assembly and ingestion of Submission Information Packages (SIPs).

OpenText InfoArchive SDK

The OpenText InfoArchive SDK is a Java library that makes it quick and easy to create SIPs regardless of what type of data it contains or where that data originates from. A SIP (Submission Information Package) is a package consisting of packaging information, meta-data (structured data in the form of XML) and optionally a collection of unstructured data files.

The IA SDK aims to make the process of creating SIPs simpler by allowing a developer to dynamically assemble both the XML file containing the structured data as well as the entire SIP itself. It’s especially easy to create SIPs from any collection or stream of Plain Old Java Objects regardless of if they represent files, SQL query result sets, emails, tweets, etc.

You can also use the SDK to ingest SIPs into InfoArchive and even to configure InfoArchive. For this functionality you must have access to a running InfoArchive server. The SDK supports version 4.0 of InfoArchive and newer.

Overview

The SDK consists of the following jars:

• infoarchive-sdk-core is the core of the SDK

• infoarchive-sdk-stringtemplate contains code for working with the StringTemplate template engine

• infoarchive-sdk-velocity contains code for working with the Velocity template engine

• infoarchive-configuration contains code for working with InfoArchive configurations. This is currently in the proof of concept phase and not ready for production

• infoarchive-yaml contains code for working with InfoArchive declarative configurations in YAML

All jars can be found in the Central Repository. The easiest way to get them is through a dependency management system like Gradle or Maven. For the latest version, see the maven-central badge at the top of this page.

Gradle

dependencies {
  compile 'com.opentext.ia:infoarchive-sdk-core:11.2.9'
}

Maven

<dependencies>
  <dependency>
    <groupId>com.opentext.ia</groupId>
    <artifactId>infoarchive-sdk-core</artifactId>
    <version>11.2.9</version>
  </dependency>
</dependencies>

Versioning

The InfoArchive SDK uses semantic versioning, which means that backwards incompatible changes will only occur in major versions. These breaking changes are documented on the wiki.

An overview of changes since version 6.1.0 can be found in the change log.

Usage

For an introduction to the SDK and some lab exercises, see the related lab project. For examples on how to use the SDK, see the sample programs.

Contributing

See the CONTRIBUTING file on how to get started.