Skip to main content

xSuite Archive Prism User Guide

Glossary

Glossary

Elasticsearch

Elasticsearch is a search engine based on Apache Lucene. Elasticsearch enables the search and filtering of attachments of various types using plug-ins and Google-like search options. Elasticsearch is only used in xSuite Archive Prism for indexing documents. MongoDB is used for all other storage (except for the file archive storage itself).

Legal hold

Legal Hold is a change lock for all users. A legal hold is set via the metadata field DoNotDeleteBefore metadata field. This field contains a date/time value before which a document cannot be deleted. The metadata is only entered in the administration database. This does not change the documents in the archive.

MongoDB

MongoDB is a NoSQL database. MongoDB has a high hourly data throughput, in the high double-digit million range. The database can be used in various operating modes. The operating mode that is used almost everywhere has a high level of data security. The data throughput and data security characterize MongoDB for archive systems.

Number Range

Number ranges generate consecutive numbers. The implementation ensures that there are no gaps in the numbering. Any existing gaps indicate that a document has been deleted. Number ranges support audit-proof archiving.

Reference

Each document has a unique reference. A document can be found in the archive system via the reference. A reference is always structured according to the pattern ACDC:///{tenant}/archive path$DocumentID. The specification of a tenant is optional. Example: ACDC:///Customer$25d6602ac13211e58126000000000000

Retention

The retention period is the retention period of an archive document. Once the retention period has expired, the documents can no longer be opened via the software. This does not generally imply that these documents are also physically deleted at this point. You can define retention via the archive properties or the document type properties.

Single instance

"Single instance" is an archive operating mode. In this operating mode, an identical attachment is only saved once. For this purpose, a hash of the file content must be determined before storage. Files are considered identical if the hash is the same. The archive holds a MongoDB collection for these files, in which the hash and a reference counter are managed. With each new attachment with the same hash, the counter number will go up. If an attachment is deleted, the counter number will decrease. If the counter is 0, the entry in the database and the attachment can be deleted.

You can define the operating mode via the SingleInstance archive property.