HCP Tenant Management Help


Properties for advanced queries with the HDDS search facility

The table below presents the properties you can use in advanced queries while the HDDS search facility is active. For each property, the table shows the case-sensitive property name, the data type, a description, an example, and the equivalent structured search property, if any. Values for properties with a data type of string follow the rules for search terms in simple searches. For information about these rules, see Search terms. For information about specifying datetime values, see Specifying dates.

Note: You cannot use $now for datetime values in advanced queries.

Advanced search property Data type Description Example Structured search equivalent
accesstime

Datetime

The POSIX access time (atime) attribute for the object. Users and applications can change this metadata.

accesstime:range
(2011-11-12T05:00:00Z,
max, from="GE")

Access Time

archivedtime

Datetime

The date and time the object was created in the namespace (that is, when the data was added to the namespace).

archivedtime:range:(min,
2011-11-01T05:00:00Z, to="LT")

Ingest
Time

attachment

String

The name of a file attached to the email.

attachment:"Sales Quotas 2012"

Email
Attachment
Name

author

String

The value of the Author metadata property that occurs in many Microsoft® Office and Adobe PDF documents.

author:"lgreen"

Author

body

Composite

The data content, name, title, and email subject of the object. This property is the equivalent of a simple search.1

content:"medic*"

Object
Content

category String

The value of the Category metadata property that occurs in many Microsoft Office and Adobe PDF documents.

category:"Sales Minutes"

Category

changetime

Datetime

The POSIX change time (ctime) attribute for the object. This is the last time the object metadata changed.

changetime:range
(2011-11-01T04:00:00Z,
max, from="GE")

Change Time

charset

String

The character set or encoding used in the document. Use unknown for documents for which HCP cannot determine the character set.

charset:string("utf-8")

Character Set

contenttype

String

The object MIME type.2

contenttype:string
("application/zip")

Object Type

dataindexed

Int32

An indication of whether the object content and/or custom metadata is indexed and whether the object name is valid UTF-8 encoding. Valid values are the sum of any combination of these:

0 Object name is percent encoded, if necessary.

Content is indexed.

2 Content is not indexed because HCP could not determine the MIME type.

3 HDDS: Content is not indexed because it exceeds ten MB.
HCP: Content is not indexed because it exceeds 50 MB.

10 Custom metadata is indexed.

20 Custom metadata is not indexed due to invalid XML.

30 HDDS: Content is not indexed because it exceeds ten MB.
HCP: Content is not indexed because it exceeds 50 MB.

90 Object has no custom metadata.

100 Object name is valid UTF-8 encoding.

dataindexed:range(100,190,
from="GE",to="LT")

N/A

emailbcc

String

The email address of one blind-copied email recipient.

emailbcc:or
("pcornflower@example.com")

Email BCC

emailcc

String

The email address of one copied email recipient.

emailcc:rsilver@example.com

Email CC

emaildate

Datetime

The date the email was sent.

emaildate:range
(2011-11-14T04:00:00Z,
2011-11-15T04:00:00Z,
from="GE", to="LT")

Email Sent
Date

emailfrom

String

The email address of an email sender.

emailfrom:"lgreen@example.com"

Email From

email
messageid

String

The ID of the email in the namespace.

emailmessageid:"73495
B59-04A3-59FC-573D-
8380897A78BB@example.
com-mbox.eml"

Email
Message ID

emailsubject

String

The text in the email subject line.

emailsubject:"Weekly Sales
Department Meeting,
Minutes -- 2/2/12"

Email Subject

emailto

String

The email address of one email recipient.

emailto:rsilver@example.com

Email To

expiration
time

Datetime

The retention setting for the object. Valid values are:

For objects that can never be deleted:

1970-01-01T00:00:03Z

For objects that can be deleted at any time:

range(current-datetime,
max)

For objects that expire at a specific date and time:

range(datetime,
datetime,from="GE",
to="LE")

In this criterion, the two variables specify the same date and time.

For objects that expire on a specific date:

range(dateT00:00:00Z,
date-plus-one
T00:00:00Z,
from="GE", to="LT")

In this criterion, the second date is one day later than the first.

For objects that do not yet have a retention setting:

1970-01-01T00:00:02Z

For objects that have expired:

range(1970-01-
01T00:00:10Z,
current-datetime)

Any of these values can return objects for which the retention setting is a retention class. This happens for objects that had a retention setting before being assigned to a class.

expirationtime:range
(2015-01-13T00:00:00Z,
2015-01-14T00:00:00Z,
from="GE", to="LT")

Retention

filename

String

All or part of a path and object name, starting after fcfs_data, data, or rest.

filename:"french/news_f/
pres03_f/mou_16feb03_f.doc"

Object Path

format

String

The format of the object content. This is typically the name of the application used to create the content.3

format:"Adobe Photoshop"

Content
Format

gid

Int32

The POSIX group ID of the owning group for the object.

gid:24

GID

gid

String

The cryptographic hash value of the object.

hash:"9B6D8A603659B447DA4..."

Hash

hash

String

The cryptographic hash value of the object.

hash:"9B6D8A603659B447DA4..."

Hash

hold

Int32

An indication of whether the object is currently on hold. Valid values are:

1 — The object is on hold.

0 — The object is not on hold.

hold:"1"

Retention
Hold

language

Datetime

The POSIX modify time (mtime) attribute for the object. Users and applications can change this metadata.

modtime:not(range
(2011-11-04T04:00:00Z,
2011-11-10T04:00:00Z,
from="GE", to="LE"))

Modification
Time

permissions Int32

The decimal equivalent of the octal value of the POSIX permissions for the object.4

permissions:420

This is equal to octal 644.

Permissions

retention
class

String

The retention class specified as the retention setting for the object.

retentionclass:"HlthReg-107a"

Retention
Class

shred

Int32

An indication of whether the object will be shredded when it’s deleted. Valid values are:

1 — The object will be shredded.

0 — The object will not be shredded.

shred:"0"

Shredding

size

Float

The object size, in bytes. This is the exact size of the object content. For example, to search for a two KB object, you need to specify 2048, not 2000.

size:range(min, 5000, to="LT")

Size

subject

String

The value of the Subject metadata property that occurs in many Microsoft Office and Adobe PDF documents.

subject:quotas

Subject

title

String

The value of the Title metadata property that occurs in many Microsoft Office and Adobe PDF documents.

title:"Monthly Sales Statistics --
February 2012"

Title

uid

Int32

The POSIX user ID of the object owner.

uid:72

UID

1. For information about simple searches, see Working with simple searches.

2. For information about the MIME types that HDDS recognizes for search operations, see the applicable HDDS documentation.

3. For information about the document formats that HDDS recognizes for search operations, see the applicable HDDS documentation.

4. For information about octal values for permissions, see Understanding returned metadata.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.