> For the complete documentation index, see [llms.txt](https://docs.migration-center.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.migration-center.com/importers/doxis-importer.md).

# Doxis Importer

## Introduction

The Doxis Importer imports documents and E-Files into Doxis through the Doxis Java API.

The importer can:

* Import content, representations, class descriptors, and system attributes.
* Create document version trees with major and minor versions.
* Update the content and metadata of documents imported before.
* Link documents to static folders in existing E-Files.
* Compare content checksums after import.

## Known issues and limitations

* Document updates need a **Mutable** document class. The document lifecycle state must permit changes to existing content.
* Update objects cannot change **Document Date**.
* Document **Owner** applies to the complete version tree.
* The importer cannot currently set **Creation Date** or **Version Creator**.
* The importer creates new E-Files. It cannot update existing E-Files.
* Content integrity checks apply only to the first content part of the default representation.
* Errors when setting different database on different versions while E-File linking is also being done (#82804)

## Prerequisites

### Doxis connection

The connector uses **Doxis Java API 14.4.2** and connects to the Doxis server on port **443**.

### Doxis configuration

The target classes, descriptors, databases, and owner accounts must exist in Doxis. Each document class must have at least one filing dialog.

The import account must have permission to:

* Create documents and E-Files in the selected classes and databases.
* Set descriptors and system attributes.
* Check out, change, and check in documents for updates.
* Add document links to the destination E-Files.&#x20;

## Importer Configuration

The common adaptor parameters are described in [Common Parameters](https://docs.migration-center.com/common-parameters#common-adaptor-details).

The configuration parameters available for the Doxis importer are described below:

### Importer parameters

For common settings, see [Common Parameters](https://docs.migration-center.com/common-parameters#common-adaptor-details).

* **hostname**\*\
  The Doxis server hostname. The connector uses port **443**.
* **username**\*\
  The Doxis login name for the import account.
* **password**\*\
  The password for the import account.
* **checkContentIntegrity**\
  Compares the scanned content checksum with the Doxis checksum after import. The default is **disabled**.\
  See [Content integrity](#content-integrity).
* **numberOfThreads**\*\
  The number of parallel import threads. Use an integer from **1 to 10**. The default is **10**.
* **loggingLevel**\*\
  See [Common Parameters](https://docs.migration-center.com/common-parameters#logging-level).

{% hint style="warning" %}
Parameters with an asterisk **(\*)** are mandatory.
{% endhint %}

Invalid connection settings, credentials, or thread counts prevent the import.

## Documents

Create a migset with a migration path that ends in **ToDoxis(document)**.&#x20;

Each document uses the predefined **doxis\_document** object type and an object type for its Doxis class.

### Rules for System Attributes

A migset with target type **Doxis(document)** has these system attributes:

* **Database**\
  The Doxis database **Short Name**. For new documents, an empty value selects the class default.\
  See [Database selection](#database-selection).
* **eFileLocations**\
  One or more destinations in existing E-Files. Format: `<E-FileID>#<Folder>/<Subfolder>`.\
  See [Document links to E-Files](#document-links-to-e-files).
* **isCurrentVersion**\
  **true** or **1** selects the version as current. **false** or **0** does not select it.\
  If left empty the last version of a version tree will be set as Current
* **isMajorVersion**\
  **true** or **1** selects a major version with release status **RELEASED**.\
  **false** or **0** selects a minor version with release status **IN\_PROGRESS**.\
  If left empty the full version tree will be set as Major.
* **mc\_content\_location**\
  One or more content file paths. The importer puts all files in the default representation.\
  If empty, the importer uses the scanned object's content location.
* **Owner**\
  The login name of an existing Doxis user. An empty value does not set the owner.
* **Representations**\
  Additional content file paths. Each file becomes a separate representation. An empty value creates no additional representations.
* **target\_type**\*\
  Two repeating values in this order: **doxis\_document**, then the Doxis document class name. Both values are mandatory.

### Content and representations

Use **mc\_content\_location** for the default representation. Use **Representations** for additional representations.&#x20;

Each document version can have different content and representations.

### Content integrity

If **checkContentIntegrity** is enabled your source objects need to have had their checksum values calculated during the scanning process.&#x20;

{% hint style="warning" %}
To use the Content Integrity Check feature, enable **Calculate checksum** for the relevant storage adapter in **Doxis CSB Superadministration**. Content Integrity Check uses this checksum to verify content integrity during import.
{% endhint %}

This checksum value needs to have been calculated using the algorithm and encoding configured in Doxis CSB for the relevant storage adapter.&#x20;

Different checksums, or an absent Doxis checksum, cause an import error.

### Database selection

Set **Database** to the Doxis database **Short Name**. The database must belong to the document class being used.&#x20;

For new documents, an empty value uses the class default. For new versions and updates, an empty value does not change the existing database.

{% hint style="warning" %}
A database change through a new version or update can move the version tree and change its Doxis IDs. Use the same database throughout the tree unless you intend to move it.
{% endhint %}

{% hint style="warning" %}
**Changing the Database** inside a version tree **while also linking documents to E-Files** required the import to be done in two runs, one for the versions set to the first database and a second run for the versions set to the second database, with subsequent runs if multiple database changes are done.\
Doing the entire import in one run will throw an error when switching from one database to the other.
{% endhint %}

### Linking Documents to E-Files

Use **eFileLocations** to link documents to existing static folders. Enter one value for each destination:

```
<E-FileID>#<Folder>/<Subfolder>
```

Replace `<E-FileID>` with the Doxis E-File ID. Use folder names exactly as they appear in Doxis. The E-File and all folders in the path must exist.

The path must include at least one folder after **#**. An E-File ID alone is not sufficient.

For a slash inside a folder name, use `\/`. For example, this path refers to **Approved** inside **Invoices/2026**:

```
<E-FileID>#Invoices\/2026/Approved
```

Multiple values can refer to different folders or E-Files. The importer adds links for new documents, versions, and updates. It reuses existing links that apply to the complete version tree.

## Versions and Updates

### Document versions

The importer uses the version relationships in migration-center to create the Doxis version tree. The parent must still exist in Doxis. A missing parent causes an import error.

Use **isMajorVersion** to select major or minor versions. Use lowercase **true** or **false**, or **1** or **0**. This flag sets the release status. If left empty all versions will be major.

Use **isCurrentVersion** to select the version that will be set as current. Use lowercase **true** or **false**, or **1** or **0**. Only one version per version tree can be set as current. If left empty the last version will be set to Current.

### Delta migration

The importer can add new documents, add versions, and update document content and metadata.

Updates change the existing version. They do not create a new version. The importer checks out the document, applies the changes, and checks it in.

**isMajorVersion** and **isCurrentVersion** apply to new documents and new versions. Update objects do not change these flags.

For content updates:

* New primary content replaces the parts of the default representation. Without primary content, the existing content stays unchanged. An empty **mc\_content\_location** still uses the update object's scanned content location.
* A nonempty **Representations** list replaces all additional representations. Include every additional representation that you want to keep. An empty list keeps the existing additional representations.
* **Document Date** stays unchanged.

{% hint style="warning" %}
Because of how the content hash is generated in Doxis, if an Update object fails because of an invalid **Content Integrity** check the incorrect Update object will still be imported.\
You will need to set the correct content file and reimport the Update to fix this.
{% endhint %}

## E-Files

Create a migset with a migration path that ends in **ToDoxis(efile)**. Select the path that matches the source object type.

Examples: **FilesystemToDoxis(efile)** for filesystem folders and **CsvExcelToDoxis(efile)** for CSV/Excel objects. The source object does not have to be a folder.

### Rules for System Attributes

A migset with target type **Doxis(efile)** has these system attributes:

* **target\_type**\*\
  Two repeating values in this order: **doxis\_efile**, then the Doxis E-File class name. Both values are mandatory.
* **Owner**\
  The login name of an existing Doxis user. An empty value does not set the owner.

### E-File attributes and associations

For an E-File class named **CustomerFile**, set **target\_type** to these two separate values:

```
doxis_efile
CustomerFile
```

Use the same association procedure as for documents. Use **doxis\_efile** and the E-File class object type.

Associate a transformation rule with **Instance Date** in **doxis\_efile**. This attribute is optional. Use the migration-center date format. The date must be within the applicable database partition range.

Define class descriptors on the **CustomerFile** object type. Match the descriptor definitions to the Doxis E-File class.

Doxis creates the global folders defined by the E-File class: structuring, static, dynamic, and all-references folders. Define this structure in Doxis before import.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.migration-center.com/importers/doxis-importer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
