Index Server UB2 User manual (Version 1.0)  
 

4 Searchable metadata attributes

4.1 HELIOS specific metadata attributes

HELAnnotationStatus
 

The status of a WebShare/PrintPreview annotation. (annotationindexer)

This attribute can take the values:
0 = No status
1 = Status OK
2 = Status rejected

4.2 Common metadata attributes

List of attribute keys, including their aliases, that are common to all file types. Some attributes are only set by specific modules:

Important:

The listed aliases can replace the metadata attributes in a simple search request. In a Spotlight search on Mac OS X, the Finder “translates” these aliases to the corresponding metadata attributes. On Mac OS X, the aliases depend on the specified OS language, so that the alias names stated here are only valid if the Finder is set to English! For other OS languages refer to the Apple Help item “Specifying criteria in the Spotlight search field”.

Please note that attribute names are case-sensitive!

kMDItemAuthors
 
Alias: author, from, by

The author, or authors, of the contents of the file. (annotationindexer, oiindexer, officeindexer, pdfindexer)

kMDItemCity
 
Alias: city

Identifies city of origin according to guidelines established by the provider, e.g. “New York”, “Berlin”, or “Toronto”. (oiindexer)

kMDItemComment
 
Alias: comment

A comment related to the file. This comment is not displayed in the Mac Finder. (mediaindexer, officeindexer, oiindexer)

kMDItemContentCreationDate
 
Alias: created, date

The date and time that the content was created, e.g. the shooting date recorded by a digital camera. (oiindexer)

kMDItemContentModificationDate
 
Alias: modified, date

Date and time when the content of this item was modified. (all files and folders)

Important:

The last two attributes share the same alias (“date”). So if you search one attribute by alias you will also get results for the other.

kMDItemContentType
 

Uniform Type Identifier of the file. For example, a JPEG image file will have a value of “public.jpeg”. (mediaindexer, officeindexer, oiindexer, pdfindexer, txtindexer)

kMDItemCopyright
 
Alias: copyright

Copyright owner of the file contents. (mediaindexer, oiindexer)

kMDItemCountry
 
Alias: country

The full, publishable name of the country or primary location where the intellectual property of the item was created, according to guidelines of the provider. (oiindexer)

kMDItemCreator
 
Alias: creator

Name of the application used to create the document content. For example, “Photoshop” or “RagTime”. (mediaindexer, officeindexer, oiindexer)

kMDItemDescription
 

Description of the kind of item this file represents. (officeindexer, oiindexer, pdfindexer)

kMDItemDisplayName
 
Alias: name

The file name. (all files and folders)

kMDItemDueDate
 

The date when this item will be due. (annotationindexer)

kMDItemEncodingApplications
 

Applications used to convert the original content into its current form. For example, a PDF file might have an encoding application set to “Distiller”. (mediaindexer, officeindexer, pdfindexer)

kMDItemFinderComment
 

Finder comments for this item. (all files and folders)

kMDItemHeadline
 

Publishable entry providing a synopsis of the contents of the item. For example, “HELIOS receives FograCert”. (mediaindexer, oiindexer)

kMDItemIdentifier
 
Alias: subject

Formal identifier used to reference the resource within a given context. For example, the message ID of a mail message. (mediaindexer, officeindexer, oiindexer)

kMDItemInstructions
 

Instructions concerning the use of the item, such as embargoes and warnings. For example, “Don't feed after midnight”. (oiindexer)

kMDItemKeywords
 
Alias: keyword

Keywords associated with this file. For example, “Birthday”, “Important”. (mediaindexer, officeindexer, oiindexer, pdfindexer)

kMDItemKind
 
Alias: kind

Description of the kind of item this file represents. (mediaindexer, officeindexer, oiindexer, pdfindexer, txtindexer)

kMDItemNumberOfPages
 
Alias: pages

Number of pages in the document. (officeindexer, oiindexer, pdfindexer)

kMDItemPageHeight
 

Height of the document page, in points (72 points per inch). For PDF files this indicates the height of the first page only. (pdfindexer)

kMDItemPageWidth
 

Width of the document page, in points (72 points per inch). For PDF files this indicates the width of the first page only. (pdfindexer)

kMDItemPublishers
 

Publishers of the item. For example, a person, an organization, or a service. (mediaindexer, officeindexer, oiindexer)

kMDItemPublishingDate
 

Contains the year in that a document was published for the first time. (mediaindexer)

kMDItemSecurityMethod
 

Encryption method used to make the item secure. PDF files return “None” or “Password Encrypted”. (pdfindexer)

kMDItemTextContent
 
Alias: intext

Contains a text representation of the content of the document. Data in multiple fields are combined using a whitespace character as a separator.

Applications can create queries using this attribute, but are not able to read the value of this attribute directly. (officeindexer, oiindexer, pdfindexer, txtindexer)

kMDItemTitle
 
Alias: title

Title of the item. For example, this could be the title of a document, the name of a song, or the subject of an e-mail message. (annotationindexer, mediaindexer, officeindexer, oiindexer, pdfindexer)

kMDItemVersion
 

Version number of the item. (pdfindexer)

kMDItemWhereFroms
 

Describes where the item was obtained from. For example, a downloaded file may refer to the URL, files received by e-mail may indicate the sender’s e-mail address, message subject, etc. (mediaindexer, oiindexer)

4.3 Image metadata attributes

The following attribute keys are used with image files only. These attributes are only set by the “oiindexer” module.

kMDItemAcquisitionMake
 
Alias: make

Manufacturer of the device used to acquire the image.

kMDItemAcquisitionModel
 
Alias: model

Model of the device used to acquire the document contents.

kMDItemAperture
 

Aperture setting used to acquire the image. This unit is the APEX value.

kMDItemBitsPerSample
 
Alias: bps

Number of bits per sample. For example, the bit depth of an image (8-bit, 16-bit etc...) or the bit depth per audio sample of uncompressed audio data.

kMDItemColorSpace
 
Alias: colorspace

Color space model used by the image. For example, “RGB”, “CMYK”, “YUV”, or “YCbCr”.

kMDItemExposureTimeSeconds
 

Exposure time used to capture the image.

kMDItemFlashOnOff
 
Alias: flash

Whether a camera flash was used to capture the image.

kMDItemFNumber
 

Diameter of the aperture relative to the effective focal length of the lens.

kMDItemFocalLength
 

Actual focal length of the lens, in millimeters.

kMDItemHasAlphaChannel
 
Alias: alpha

Whether the image has an alpha channel.

kMDItemISOSpeed
 
Alias: iso

ISO speed used to acquire the image. For example, 100, 200, 400, etc.

kMDItemMaxAperture
 

Smallest F number of the lens in APEX value units, usually in the range of 00.00 to 99.99.

kMDItemMeteringMode
 

Metering mode used to acquire the image.

kMDItemOrientation
 
Alias: orientation

Orientation of the document contents.

kMDItemPixelHeight
 
Alias: height

Height, in pixels, of the contents. For example, the image height or the video frame height.

kMDItemPixelWidth
 
Alias: width

Width, in pixels, of the contents. For example, the image width or the video frame width.

kMDItemProfileName
 
Alias: profile

Name of the color profile used by the image.

kMDItemResolutionHeightDPI
 
Alias: dpi

Resolution height, in dpi, of the image.

kMDItemResolutionWidthDPI
 
Alias: dpi

Resolution width, in dpi, of the image.

Important:

The last two attributes share the same alias (“dpi”). So if you search one attribute by alias you will also get results for the other.

4.4 File system metadata attributes

File system metadata attributes are not indexed in the database and hence cannot be searched for, but they can be displayed for each file, e.g. with “dt ftinfo”:

kMDItemFSContentChangeDate
 

File contents modification date.

kMDItemFSCreationDate
 

File contents creation date.

kMDItemFSCreatorCode
 

Resource creator information.

kMDItemFSFinderFlags
 

The Finder flags.

kMDItemFSHasCustomIcon
 

Whether the file has a custom icon.

kMDItemFSInvisible
 

Whether the file is invisible.

kMDItemFSLabel
 

Index of the Finder label of the file. Possible values are 0 through 7.

kMDItemFSName
 

File name of the item.

kMDItemFSOwnerGroupID
 

Group ID of the owner of the file.

kMDItemFSOwnerUserID
 

User ID of the owner of the file.

kMDItemFSSize
 

Size, in bytes, of the file on disk.

kMDItemFSTypeCode
 

Resource type information.

kMDItemPath
 

Complete file path.

4.5 Group metadata attributes

_kMDItemGroupId
 

Search all files that belong to a group.
The following groups are supported:

Group ID Document type
11 PDF documents
13 Image files
10 Media files

4.6 Overview of metadata attribute aliases

Although the attribute alias names are all documented lower-case in this manual, they can be entered case-insensitive in a Spotlight search.

Alias Metadata attribute
alpha kMDItemHasAlphaChannel
author kMDItemAuthors
bps kMDItemBitsPerSample
by kMDItemAuthors
colorspace kMDItemColorSpace
city kMDItemCity
comment kMDItemComment
copyright kMDItemCopyright
country kMDItemCountry
created kMDItemContentCreationDate
creator kMDItemCreator
date kMDItemContentCreationDate
kMDItemContentModificationDate
dpi kMDItemResolutionHeightDPI
kMDItemResolutionWidthDPI
flash kMDItemFlashOnOff
from kMDItemAuthors
height kMDItemPixelHeight
intext kMDItemTextContent
iso kMDItemISOSpeed
keyword kMDItemKeywords
kind kMDItemKind
make kMDItemAcquisitionMake
model kMDItemAcquisitionModel
modified kMDItemContentModificationDate
name kMDItemDisplayName
orientation kMDItemOrientation
pages kMDItemNumberOfPages
profile kMDItemProfileName
subject kMDItemIdentifier
title kMDItemTitle
width kMDItemPixelWidth

HELIOS Website © 2011 HELIOS Software GmbH  
HELIOS Manuals April 17, 2013