Meta data keys (V1)
Key | Type | Description | Example |
|---|---|---|---|
None | String | Key to perform an empty search | "" |
Reference | String | Internal reference of the archived document or attachment. | "stdASD:DefaultShard:SlDbox:c5a8315f92923673005b51fd86771f0e:117437" |
ExternalKey | String | Key that can be used by external applications to identify their archived content in xSuite Archive Helix e.g. SAP document identifer | "000C29C9FF961EDAB8BE3F960FAD8A49" |
CreateTimeStamp | Date | Time stamp when content was created. All dates are UTC and must be provided as an ISO-date string. | "2021-04-20 06:44:51" |
StorageState | Integer | Storage state: 0=Deleted, 1=Temporary, 2=Stored (unversioned), 3=Archived (versioned), 4=Read only | 3 |
DestinationStorageState | Integer | Currently not used in xSuite Archive Helix, available for documents migrated from xSuite Archive Prism that have been transferred to a read-only storage. | 4 |
Creator | String | Username of the user or process that created content. | "sys_SYS_USER" |
Hash | String | Document hash value. | "Md5:FE70C326C74AB6CF5E313972A5511CCB" |
Version | String | Human-readable version of the document | "1.0" |
ModifyTimeStamp | Date | Time stamp when content was modified. All dates are UTC and must be provided as an ISO-date string. | "2021-04-20 06:44:51" |
RetentionTimeStamp | Date | Time stamp when content expires and will be deleted afterwards. Can be overridden by a legal hold. All dates are UTC and must be provided as an ISO-date string. | "2031-04-20 23:59:59" |
DocumentType | String | Name of a document type. When not null, validation is performed if the document conforms to the document type. | "sys_Invoice" |
IndexedBy | String | When a document is indexed, then this meta data value contains the index name and the image size of a generated thumbnail image for each attachment. A value of 0 indicates that no thumbnail will be generated. Can be overridden by a configuration value that forces thumbnail image createion and size. | "/sys_Invoice=0" |
FileName | String | File name of an attachment | "000003-DE-AtomicIt.e-21868.pdf" |
MimeType | String | Content type or MIME type of an attachment. | "application/pdf" |
FileSize | Int64 | Size in bytes of the binary content of an attachment | 81412 |
DocumentTypeVersion | String | Document type version. | "3" |
Modifier | String | Username of the user or process that modified content. | "sys_SYS_USER" |
NotIndexable | Bool | When set to true, content will not be indexed | false |
GenericMetadata | String | A container for generic meta data as a string in the format property:value;property:value. Currently used for documents that are stored via SAP ArchiveLink in xSuite Archive Helix. | "docProt=rcud;receivedCreateTimestamp=2020-08-19T08:00:06.488Z" |
SessionId | String | Session identifier used for uploading files | "" |
Shard | String | Shard name, for internal use only. | "DefaultShard" |
DocumentSize | Int64 | Size in bytes of the document including all binary content in uncompressed form. | 123941 |
RecoverTimeStamp | Date | Time stamp when a document was recovered. All dates are UTC and must be provided as an ISO-date string. | "2021-04-20 23:59:59" |
RecoveredBy | String | Username of the user or process that recovered the document. | "sys_SYS_USER" |
DoNotDeleteBefore | Date | Time stamp that overrides retention in RetentionTimeStamp. Usually set when a legal hold is applied to a document. All dates are UTC and must be provided as an ISO-date string. | "2099-04-20 23:59:59" |
Tags | String | A comma-separated list of tags associated with the document | "Invoice,2021,no-tax" |
CheckedOutFor | String | User name of the user or process that has checked out a document. Currently not in use. | "sys_SYS_USER" |
CheckedOutSince | Date | Time stamp when document was checked out. All dates are UTC and must be provided as an ISO-date string. | "2021-04-20 08:45:21" |
LegalHoldMarker | String | Legal hold marker is a text or file reference describing the legal hold that is applied to a document. | "201.401.A" |
SiHash | String | Single instance hash value for an attachment. Reserved for future use. | "Md5:FE70C326C74AB6CF5E313972A5511CCB" |
SiOwner | String | Reference to the binary content of a single instance stored attachment. Reserved for future use. | |
ChangeToken | String | Change token for updating a document. Helps avoiding colliding updates. | |
VersionComment | String | Comment for a document version | "Automatic update of SAP ArchiveLink document. Added index data." |
SapArchiveLinkLevel | Integer | Applies to documents that are archived in xSuite Archive Helix via SAP ArchiveLink HTTP Content Server Interface. 1=Not indexed, 2=Indexed | 1 |
FolderId | String | Folder identifier for xSuite Folders. Available for documents migrated from xSuite Archive Prism that have been created by xSuite Folders | |
FolderCreateTimeStamp | Date | Time stamp when document was created in xSuite Folders. Available for documents migrated from xSuite Archive Prism that have been created by xSuite Folders | |
FolderReadTimeStamp | Date | Time stamp when document was last read in xSuite Folders. Available for documents migrated from xSuite Archive Prism that have been created by xSuite Folders | |
FolderTitle | String | Title of the document in xSuite Folders. Available for documents migrated from xSuite Archive Prism that have been created by xSuite Folders | |
FolderLink | String | Link to the document in xSuite Folders. Available for documents migrated from xSuite Archive Prism that have been created by xSuite Folders | |
FolderReviewTimeStamp | Date | Time stamp when document was reviewed in xSuite Folders. Available for documents migrated from xSuite Archive Prism that have been created by xSuite Folders | |
TrackingReference | String | Tracking reference serialized as string | |
TrackingReferenceType | String | Tracking reference type. Must be a .NET type string | "System.String" |
PhysicalDocumentSize | Int64 | Physical document size of the document in bytes. Used for accounting. | 123941 |
SapArchiveLinkIndexingPostponedUntil | Date | Time stamp until next retry of xSuite Archive Indexer for SAP is postponed. All dates are UTC and must be provided as an ISO-date string. | "2099-04-20 23:59:59" |
SapArchiveLinkIndexingRetries | Integer | Number of retries of xSuite Archive Indexer for SAP. | 1 |
TrackingId | String | Tracking identifier, must be GUID serialized to a string. | "2C5ABD53-0220-40FD-81A6-E2896444E71A" |
TrackingKey | String | Tracking key | "ABC-001" |
RetentionPeriod | String | Retention period string. Constructed by a positive integer and a period suffix. Allowed suffixes are: y=years, m=months and d=days. | "10y" |