Skip to main content

xSuite Helix - Hilfe

Document properties for meta data search (V2)

Property

Type

Description

Example

Archive

String

Name of the archive where the document is stored

SELECT * FROM 'cst_Invoice'

Attachments.FileName

String

Attachment file name

SELECT * FROM 'cst_Invoice' WHERE 'Attachments.FileName' = 'part1.txt'

Attachments.Key

String

Attachment key, also Storage key

SELECT * FROM 'cst_Invoice' WHERE 'Attachments.Key' = '4c644748-1931-4dac-b0e8-48eb75b857f7'

Attachments.Length

Long Integer

Attachment content length in bytes

SELECT * FROM 'cst_Invoice' WHERE 'Attachments.Length' >= 30

Attachments.MimeType

String

Attachment content type

SELECT * FROM 'cst_Invoice' WHERE 'Attachments.MimeType' = 'text/plain'

Created

DateTime

Creation date and time (UTC) of the document

SELECT * FROM 'cst_Invoice' WHERE 'Created' BETWEEN '2024-08-05T09:10:42.688Z' AND '2024-08-05T23:59:59.000Z'

IsIndexed

Bool

Indicates whether the document should be indexed

SELECT * FROM 'cst_Invoice' WHERE 'IsIndexed' IS TRUE

Key

String

Key of the document

SELECT * FROM 'cst_Invoice' WHERE 'Key' = 'eaf33162328f4d738d1ddc3cae22a61f_1'

IsVersioned

Bool

Indicates whether the document is versioned (audit-proof archiving)

SELECT * FROM 'cst_Invoice' WHERE 'IsVersioned' IS TRUE

LitigationHold

Object

Litigation (legal) hold applied to the document

SELECT * FROM 'cst_Invoice' WHERE 'LitigationHold' IS NULL

LitigationHold.Reference

String

Reference e.g. file number of the litigation hold

SELECT * FROM 'cst_Invoice' WHERE 'LitigationHold.Reference' = 'R-2024/IV-00129'

LitigationHold.ExpirationDate

DateTime

Expiration date of the litigation hold

SELECT * FROM 'cst_Invoice' WHERE 'LitigationHold.ExpirationDate' < '2024-12-31T23:59:59.999Z'

Modified

DateTime

Last modification date and time (UTC) of the document

SELECT * FROM 'cst_Invoice' WHERE 'Modified' BETWEEN '2024-08-05T09:10:42.688Z' AND '2024-08-05T23:59:59.000Z'

ModifiedBy

String

User or process that performed last modification of the document

SELECT * FROM 'cst_Invoice' WHERE 'ModifiedBy' = 'service-account-archive'

ModifiedById

GUID

User or process that performed last modification of the document

SELECT * FROM 'cst_Invoice' WHERE 'ModifiedById' = '2d17390c-0069-4352-b654-4ac06ced5696'

RetentionDate

DateTime

Date and time (UTC) when the document should be removed permanently (not deleted until litigation hold is expired).

SELECT * FROM 'cst_Invoice' WHERE 'RetentionDate' < '2024-08-05T00:00:00.000Z'

RootKey

String

Key of the documents root version

SELECT * FROM 'cst_Invoice' WHERE 'RootKey' = 'eaf33162328f4d738d1ddc3cae22a61f_1'

SapParameters.ComponentId

String

Content Server document component id

SELECT * FROM 'cst_Invoice' WHERE 'SapParameters.ComponentId' = 'data'

SapParameters.ContentRepository

String

Content Server document component id

SELECT * FROM 'cst_Invoice' WHERE 'SapParameters.ContentRepository' = 'ZD'

SapParameters.DocumentId

String

Content Server document id

SELECT * FROM 'cst_Invoice' WHERE 'SapParameters.DocumentId' = '7F84BDCDBAB641DF9CAEE343DA65AEF8'

SapParameters.DocumentProtection

String

Content Server document protection

SELECT * FROM 'cst_Invoice' WHERE 'SapParameters.DocumentProtection' = 'rcud'

SapParameters.IndexStatus

Integer

Indexer for SAP indexing status (0 = Unknown, 1 = Not Indexed, 2 = Indexed)

SELECT * FROM 'cst_Invoice' WHERE 'SapParameters.IndexStatus' = 1

SapIndexer

Object

Indexer for SAP meta data for this document

SELECT * FROM 'cst_Invoice' WHERE 'SapIndexer' IS NULL

SapIndexer.HasBeenIndexed

Bool

Indicates whether Indexer for SAP has indexed this document

SELECT * FROM 'cst_Invoice' WHERE 'SapIndexer.HasBeenIndexed' IS TRUE

SapIndexer.NextIndexingAttempt

DateTime

Next date and time (UTC) when Indexer for SAP tries to index this document

SELECT * FROM 'cst_Invoice' WHERE 'SapIndexer.NextIndexingAttempt' IS NOT NULL AND 'SapIndexer.NextIndexingAttempt' > '2024-08-05T00:00:00.000Z'

SapIndexer.IndexingRetries

Integer

Number of retries the Indexer for SAP tried to index this document

SELECT * FROM 'cst_Invoice' WHERE 'SapIndexer.IndexingRetries' > 1

SchemaKey

String

Key of the JSON schema used for validation of the contents of this document

SELECT * FROM 'cst_Invoice' WHERE 'SchemaKey' = 'sys_CaptureInvoice'

State

String

State of the document, usually 'Finalized'

SELECT * FROM 'cst_Invoice' WHERE 'State' != 'Finalized'

TrackingId

GUID

Tracking identifier

SELECT * FROM 'cst_Invoice' WHERE 'TrackingId' = '91c22725-a1cd-43d7-9fc9-a7d1ea4c25e6'

TrackingKey

String

Tracking identifier

SELECT * FROM 'cst_Invoice' WHERE 'TrackingKey' = '9fe9cd81-0067-44ea-a313-0858e751ebf1'

Version

Integer

Version of the document

SELECT * FROM 'cst_Invoice' WHERE 'Version' = 1

VersionComment

String

Version of the document

SELECT * FROM 'cst_Invoice' WHERE 'VersionComment' = 'test'