Skip to main content

xSuite Archive Prism User Guide

An overview of document metadata

Each archive document has the following metadata:

Name

Data type

Description

ChangeToken

Text

Labeling for replication

If the original document and the replication have the same change token, the two documents are considered identical.

CheckedOutFor

Text

User who has linked the document in the folder CheckedOut

CheckedOutSince

Time stamp

Time at which the document was linked in the folder CheckedOut

CreateTimeStamp

Time stamp

Time at which the document was first filed

CreateTimeStamp remains identical for all subsequent versions of the document.

Creator

Text

User name of the creator

Creator remains identical for all subsequent versions of the document.

DestinationStorageState

Text

Delete by StorageState

If the document is only moved to a StorageState ("Deleted"), the original StorageState will be noted in DestinationStorageState. If the deletion is undone, this StorageState will be used for the recovery.

DocumentSize

Number

Total size of the document

DocumentType

Text

Document type (optional)

DocumentTypeVersion

Text

Document type version

DoNotDeleteBefore

Time stamp

Time for the legal hold

The document cannot be deleted via the system before this time.

ExternalFolderKey

Text

Only relevant for external file management (e.g., CMIS)

ExternalKey

Text

External key

This key is assigned externally. The SAP ArchiveLink interface stores the SAP DocID here, for example.

ExternalPath

Text

Only relevant for external file management (e.g., CMIS)

Filename

Text

File name (for attachments)

FileSize

Text

Size of an attachment

FolderReferencedBy

Text

Folder references

Individual references are separated by a comma (, ).

GenericMetadata

Text

List of properties

Individual properties are separated by a semicolon (; ).

Hash

Text

Hash value for all attachments and the main document or the hash value for an attachment

IndexedBy

Text

Indexes that have indexed this document

LegalHoldMarker

Text

Labeling for a legal hold

This metadata corresponds to the metadata DoNotDeleteBefore.

MimeType

Text

MIME type (or content type) of an attachment

Modifier

Text

The name of the user who changed the document

ModifyTimeStamp

Time stamp

The time at which the document was last changed or the time at which a new version of this document was created

RecoveredBy

Text

The user who restored the document

RecoverTimeStamp

Time stamp

The time at which the document was restored

Reference

Text

Storage Reference

RetentionTimeStamp

Time stamp

The time at which the document is to be deleted

SapArchiveLinkIndexingPostponedUntil

Time stamp

The time at which indexing is attempted again (only relevant for SAP ArchiveLink level 2)

SapArchiveLinkIndexingRetries

Number

The number of indexing attempts (only relevant for SAP ArchiveLink level 2)

SapArchiveLinkLevel

Number

SAP archiving level

The following levels are available:

  • 1: ArchiveLink

  • 2: indexed

SessionId

Number

The internal ID of the user session

Shard

Text

Shard of the document

SiHash

Text

Hash value for "single instance" management

SiOwner

Text

Document ID to which the first "Single Instance" version belongs

StorageState

Number

Life cycle

The following life cycles are available:

  • 2: filed

  • 3: archived

  • 4: archived long-term

Tags

Text

Comments

Version

Text

Version number

VersionComment

Text

Comment that was created when a new document version was created