<commit_before>image:https://img.shields.io/badge/license-mpl2-ff69b4.svg[title="License: MPL2", link="https://www.mozilla.org/en-US/MPL/2.0/"]
image:https://img.shields.io/travis/Enterprise-Content-Management/infoarchive-sip-sdk.svg[title="Travis", link="https://travis-ci.org/Enterprise-Content-Management/infoarchive-sip-sdk"]
image:https://img.shields.io/codecov/c/github/Enterprise-Content-Management/infoarchive-sip-sdk.svg[title="Code coverage", link="https://codecov.io/github/Enterprise-Content-Management/infoarchive-sip-sdk"]
image:https://sonarcloud.io/api/badges/measure?key=com.opentext.ia:infoarchive-sdk&metric=sqale_debt_ratio[title="Technical Debt", link="https://sonarcloud.io/dashboard?id=com.opentext.ia:infoarchive-sdk"]
image:https://img.shields.io/maven-central/v/com.opentext.ia/infoarchive-sdk-core.svg[title="Maven Central", link="https://repo1.maven.org/maven2/com/opentext/ia/"]
image:https://javadoc-emblem.rhcloud.com/doc/com.opentext.ia/infoarchive-sdk-core/badge.svg[title="Javadoc", link="http://www.javadoc.io/doc/com.opentext.ia/infoarchive-sdk-core"]

= OpenText InfoArchive SDK

The http://documentum.opentext.com/infoarchive/[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 http://www.stringtemplate.org/[StringTemplate] template engine
* `infoarchive-sdk-velocity` contains code for working with the http://velocity.apache.org/[Velocity] template engine
* `infoarchive-yaml` contains code for working with YAML configurations

All jars can be found in the https://repo1.maven.org/maven2/com/emc/ia/[Central Repository]. The easiest way to get
them is through a dependency management system like http://gradle.org/[Gradle] or https://maven.apache.org/[Maven].
For the latest version, see the `maven-central` button at the top of this page.


*Gradle*

[source,groovy]
----
dependencies { 
  compile 'com.opentext.ia:infoarchive-sdk-core:8.3.0'
}
----

*Maven*

[source,xml]
----
<dependencies>
  <dependency>
    <groupId>com.opentext.ia</groupId>
    <artifactId>infoarchive-sdk-core</artifactId>
    <version>8.3.0</version>
  </dependency>
</dependencies><commit_msg>Update version number<commit_after>image:https://img.shields.io/badge/license-mpl2-ff69b4.svg[title="License: MPL2", link="https://www.mozilla.org/en-US/MPL/2.0/"]
image:https://img.shields.io/travis/Enterprise-Content-Management/infoarchive-sip-sdk.svg[title="Travis", link="https://travis-ci.org/Enterprise-Content-Management/infoarchive-sip-sdk"]
image:https://img.shields.io/codecov/c/github/Enterprise-Content-Management/infoarchive-sip-sdk.svg[title="Code coverage", link="https://codecov.io/github/Enterprise-Content-Management/infoarchive-sip-sdk"]
image:https://sonarcloud.io/api/badges/measure?key=com.opentext.ia:infoarchive-sdk&metric=sqale_debt_ratio[title="Technical Debt", link="https://sonarcloud.io/dashboard?id=com.opentext.ia:infoarchive-sdk"]
image:https://img.shields.io/maven-central/v/com.opentext.ia/infoarchive-sdk-core.svg[title="Maven Central", link="https://repo1.maven.org/maven2/com/opentext/ia/"]
image:https://javadoc-emblem.rhcloud.com/doc/com.opentext.ia/infoarchive-sdk-core/badge.svg[title="Javadoc", link="http://www.javadoc.io/doc/com.opentext.ia/infoarchive-sdk-core"]

= OpenText InfoArchive SDK

The http://documentum.opentext.com/infoarchive/[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 http://www.stringtemplate.org/[StringTemplate] template engine
* `infoarchive-sdk-velocity` contains code for working with the http://velocity.apache.org/[Velocity] template engine
* `infoarchive-yaml` contains code for working with YAML configurations

All jars can be found in the https://repo1.maven.org/maven2/com/emc/ia/[Central Repository]. The easiest way to get
them is through a dependency management system like http://gradle.org/[Gradle] or https://maven.apache.org/[Maven].
For the latest version, see the `maven-central` button at the top of this page.


*Gradle*

[source,groovy]
----
dependencies { 
  compile 'com.opentext.ia:infoarchive-sdk-core:8.3.3'
}
----

*Maven*

[source,xml]
----
<dependencies>
  <dependency>
    <groupId>com.opentext.ia</groupId>
    <artifactId>infoarchive-sdk-core</artifactId>
    <version>8.3.3</version>
  </dependency>
</dependencies>
{'fraction_non_alphanumeric': 0.11854863934939006, 'fraction_numerical': 0.0059430716296528, 'mean_word_length': 4.9934395501405815, 'pattern_counts': {'":': 0, '<': 23, '<?xml version=': 0, '>': 23, 'https://': 26, 'lorem ipsum': 0, 'www.': 6, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1292961', 'n_tokens_mistral': 2082, 'n_tokens_neox': 1933, 'n_words': 549}