Advanced

Advanced topics

Index field definitions

This document provides detailed information about the fields that are captured in PageSeeder's document index, most of which is exposed through the standard Search interface with no additional configuration required. 

For an overview of where these fields are used see Index fields.

Summary

Core fields available for almost all indexed items. For an explanation of the icons used on this page, see Legend of document icons. Index version shows when new fields were added to the index (blank means always existed).

Core fields

NameTypeCard.DescriptionIndex version
psidStored+Indexed1A unique identifier for the item: the URI ID or XLink ID
pstitleStored+Analyzed1The title of the XLink or URI
pstitle-sortIndexed1Used for sorting by title
psdescriptionStored+Analyzed1URI Description
pstypeStored+Indexed1document | comment | task | folder
pssubtypeStored+Indexed1document | comment | task | folder | image | video | audio | office | archive
psmediatypeStored+Indexed1Media type (MIME)
pscreateddateStored+Indexed0..1Created date
psmodifieddate-numericIndexed+Long1Last modified as a number to allow quick sorting
psmodifieddateStored+Indexed1Last modified date as an ISO 8601 date
pscontentCompressed+Analyzed1Full text content
pslabelStored+Indexed0..NAny label(s) for the item (comment label, document label) 

Media-specific

NameTypeCard.DescriptionIndex version
psfilenameStored+Analyzed1File name
psfolderStored+Indexed1Full path of the containing folder
psurifolderStored+Indexed1REMOVED - use psfolder
psancestorIndexed1..NAll ancestor folders
pssizeStored+Indexed0..1File size in bytes
psdocidStored+Analyzed0..1Document ID
psownedStored+Indexed1Is document owned by this group5002
psdocumenttypeStored+Indexed1Document type
pseditableStored+Indexed1Editable flag
pssectionidStored+Indexed1Section ID containing fragment
psbodytypeStored+Indexed1Body type
psfragmenttypeStored+Indexed1Fragment type
psfragmentformatStored+Indexed0..1Fragment format
psfragmentStored+Indexed1Fragment ID
psfragmentlabelStored+Indexed0..NAny fragment label(s) used
psblocklabelnameStored+Indexed0..NName(s) of any block labels used5002
psproperty-[name]Stored+Indexed0..NText value of PSML or comment property
psmetadata-[name]Stored+Indexed0..NText value of document metadata property
psinline-[name]Stored+Indexed0..NText value of all inline labels in item
pspara-[name]Compressed+Analyzed0..NDEPRECATED - use psblock-*
psblock-[name]Compressed+Analyzed0..NText value of all block labels in item
pslastediteddateStored+Indexed0..1Last edited date
pslatestversionStored+Indexed0..1Latest document version
psstatusStored+Indexed1Status
psstatuschangeddateStored+Indexed0..1Date status was last changed
pspriorityStored+Indexed1Priority
psassignedtoStored+Indexed1Full name of assigned to member
psassignedtoidStored+Indexed+Long1Member ID of assigned to member5003
psduedateStored+Indexed0..1Due date of task/document
psdiscussionidStored+Indexed+Long1The ID of the comment discussion
pstaskdefinitionidStored+Indexed+Long1The ID of the task definition comment
psauthorStored+Indexed0..1Author of comment/task
psauthoridStored+Indexed+Long0..1Author member ID of comment/task5003
pswidthStored+Indexed+Int0..1Width in pixels of an image
psheightStored+Indexed+Int0..1Height in pixels of an image
pspixelcountIndexed+Long0..1Width x height of an image
psgraphicsrcStored+Indexed0..NDEPRECATED - use psimagesrc
psimagesrcStored+Indexed0..NSource of all images in document
psxrefcountStored+Indexed+Int1Number of forward XRefs in item
psreversexrefcountStored+Indexed+Int1Number of reverse XRefs in item
psxreflabelStored+Indexed0..NLabel on forward XRefs in item
psreversexreflabelStored+Indexed0..NLabel on reverse XRefs in item

Details

psid

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage iconTask iconComment icon 
(ALL)

The psid is a unique identifier for the indexed item. For documents it is the URI ID, for comments it is the XLink ID.

Examples:

123
3572843214

pstitle

StoredIndexedData typeCardinalityAvailability
YesAnalyzedtext1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage iconTask iconComment icon 
(ALL)

The pstitle is a title for the indexed item. For XLinks, it is generally the comment title. For documents, it is the user title or file name if no title was specified by the user.

Examples:

"Test Document"
"Important information"

pstitle-sort

StoredIndexedData typeCardinalityAvailability
NoIndexedtext1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage iconTask iconComment icon 
(ALL)

The pstitle-sort is the same as pstitle but converted to lower case and not analysed. It is used for sorting by title.

Examples:

"Test Document"
"Important information"

psdescription

StoredIndexedData typeCardinalityAvailability
YesAnalyzedtext1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage icon 
(All except comment)

The psdescription is the description entered in the URI properties of each document. It can be used as an abstract and is generally returned in search results when there was no match in the content or other fields.

Example:

"The purpose of this document is ..."

pstype

StoredIndexedData typeCardinalityAvailability
StoredIndexedtext1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage iconTask iconComment icon 
(ALL)

The pstype is used to separate each type of indexed item. PageSeeder defines the following types of index items:

pstypeDescriptionicon(s)
folderA URI which corresponds to a folderFolder icon
documentA URI which corresponds to a fileWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage icon
fragmentA URI fragmentNo longer supported
commentA commentComment icon
taskA taskTask icon

pssubtype

StoredIndexedData typeCardinalityAvailability
StoredIndexedtext1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage iconTask iconComment icon 
(ALL)

The pssubtype is used to further separate each type (currently mainly for documents). PageSeeder defines the following subtypes of index items:

pstypepssubtypeDescriptionMedia Type
folderfolderA URI which corresponds to a folderapplication/vnd.pageseeder.folder
documentdocumentA PSML documentapplication/vnd.pageseeder*
imageimage/*
videovideo/*
audioaudio/*
officeapplication/vnd.openxmlformats*, *word, *excel
archive*x-gzip, *x-tar, *zip, *java-archive
other*
fragmentfragmentA URI fragmentapplication/vnd.pageseeder.psml+xml
commentcommentA commentapplication/vnd.pageseeder.comment+xml
tasktaskA taskapplication/vnd.pageseeder.task+xml

psmediatype

StoredIndexedData typeCardinalityAvailability
StoredIndexedtext1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage iconTask iconComment icon 
(ALL)

The psmediatype is the media type of the indexed item. All items except items of type 'fragment' have a media type. 

The table below shows the media type associated with each icon (wildcards are used to indicate any value)

IconMedia type
Folder iconapplication/vnd.pageseeder.folder
Word iconapplication/word
PDF iconapplication/pdf
HTML icontext/html
XML iconapplication/xml
text/xml
*/*+xml
icon-psstandard.pngapplication/vnd.pageseeder.document.standard+xml
PSML iconapplication/vnd.pageseeder.psml+xml
icon-default.png*/*
Image iconimage/*
Task iconapplication/vnd.pageseeder.task+xml
Comment iconapplication/vnd.pageseeder.comment+xml

 

Warning!

The media type used for this index field (application/vnd.pageseeder.document+xml) for documents in Standard Format is different from the  media type used for the document in PageSeeder text/xml. This is so that the media type can be used to differentiate XML documents from PageSeeder standard documents.

Examples:

"text/xml"
"image/png"
"application/vnd.pageseeder.comment+xml"

pscreateddate

StoredIndexedData typeCardinalityAvailability
YesIndexeddatetime0..1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage iconTask iconComment icon 
(ALL)

The date the standard document, comment or task was created. This field is only available for items created within PageSeeder.

Example:

"2012-07-06T19:00:00+11:00"

psmodifieddate-numeric

StoredIndexedData typeCardinalityAvailability
NoIndexedlong1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage iconTask iconComment icon 
(ALL)

The psmodifieddate-numeric field is used for sorting dates efficiently and is only indexed. Its stored equivalent is the psmodifieddate field.

Example:

437289139549231

psmodifieddate

StoredIndexedData typeCardinalityAvailability
StoredNodatetime1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage iconTask iconComment icon 
(ALL)

The psmodifieddate field is an ISO 8601 date and time representation of an indexed item. It is not indexed directly. The date resolution for the index is the second.

Example:

2012-07-14T12:31:00+10:00

pscontent

StoredIndexedData typeCardinalityAvailability
CompressedAnalyzedtext1Word iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconTask iconComment icon

The pscontent includes all the textual content of the index item. This field is not available for images, folders or documents that cannot be parsed for content.

Example:

"An Alice said..."

pslabel

StoredIndexedData typeCardinalityAvailability
StoredIndexedtext0..NFolder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage iconTask iconComment icon 
(ALL)

The pslabel fields store verbatim, all labels applied to the item (document label, comment label, etc.). It does not include content labels. Since multiple labels can be applied to an item, multiple fields can be stored. This field is indexed but not analyzed, so it is not possible to search individual terms within each field value.

Examples:

"test"
"bug"
"for_review"

Media-specific fields

The fields below may be available depending on the type or media type.

psfilename

StoredIndexedData typeCardinalityAvailability
YesAnalyzedtext1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage icon

The psfilename is name of the file corresponding to the document. This field is only available for documents and folders.

Examples:

"acme.xml"
"My Image.jpg"

psfolder

StoredIndexedData typeCardinalityAvailability
StoredIndexedtext1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage icon

The psfolder full path of the folder where the document is located. This field is only available for documents and folders. This field does not include a trailing '/'.

Example:

"/ps/acme/test/Images"

psancestor

StoredIndexedData typeCardinalityAvailability
NoIndexedtext1..NFolder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage icon

The full path of the folder where the document is located as well as all its parent folders are indexed as psancestor fields. This field does not include a trailing '/'.

This field is used to be able to narrow down the location of an item without knowing precisely its folder. It can also be used to compute the number of items within a folder and its descendants.

Examples:

"/ps/acme/test/Images"
"/ps/acme/test"
"/ps/acme"
"/ps"

pssize

StoredIndexedData typeCardinalityAvailability
YesAnalyzedtext0..1Word iconPDF iconHTML iconXML iconicon-default.pngImage icon

The size, in bytes, of the file corresponding to the document.

This field does not apply to folders, PSML documents, Standard Format documents, comments or tasks as they can be edited and the file size does not reflect their size accurately.

Examples:

7013
44986

psdocid

StoredIndexedData typeCardinalityAvailability
YesAnalyzedtext0..1Word iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage icon

The psdocid field takes the document ID given to the specified document. This field is only available if a document ID has been assigned to the URI.

Examples:

"ID-52634-GHG"
"PK771622"

psowned

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1Folder iconWord iconPDF iconHTML iconXML iconicon-psstandard.pngPSML iconicon-default.pngImage icon

The psowned flag indicates whether the document is owned by the current group (i.e. it is in the group's default folder).

Introduced in index version 5002 in PageSeeder version 5.9100.

Examples:

"true"
"false"

pseditable

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1icon-psstandard.pngPSML icon

The pseditable flag indicates whether the document is editable. Its only possible values are true and false. This field is only available to PSML documents or documents in Standard Format.

Examples:

"true"
"false"

psdocumenttype

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1icon-psstandard.pngPSML icon

The psdocumenttype field stores the document type of a document. If a document does not have a document type, the value of this field is set to 'none' in order to be able to easily detect documents which do not have a document type.

This field is only available to PSML or Standard Format documents.

Examples:

"component"
"book"

psbodytype

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1icon-psstandard.png

psfragmenttype

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1PSML icon

psfragmentformat

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..1PSML icon

The psfragmentformat comes from the name of the fragment element. Allowed values are psml-xref, psml-properties, psml-media.

psfragment

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1icon-psstandard.pngPSML icon

The psfragment is the fragment ID being indexed. For PDF documents, a fragment is a page.

Examples:

(page 2 of a PDF document):

"pspdf(2)"

(fragment of the PageSeeder document):

"title"

psfragmentlabel

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..Nicon-psstandard.pngPSML icon

Any fragment label(s) used in the document.

psblocklabelname

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..NPSML icon

The name(s) of any block labels used in the document.

Introduced in index version 5002 in PageSeeder version 5.9100.

pssectionid

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1PSML fragment icon

The pssectionid is the ID of the section the fragment being indexed belongs to.

psproperty-[name]

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..NPSML iconTask iconComment icon

The content of each property in the document, comment or task as a separate instance of this field.

psmetadata-[name]

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..Nicon-default.png

The content of each metadata property in the document as a separate instance of this field.

psinline-[name]

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..Nicon-psstandard.pngPSML icon

The content of each inline label in the document as a separate instance of this field.

psblock-[name]

StoredIndexedData typeCardinalityAvailability
CompressedAnalyzedtext0..NPSML icon

The content of each block label in the document as a separate instance of this field.

pspara-[name]

StoredIndexedData typeCardinalityAvailability
CompressedAnalyzedtext0..Nicon-psstandard.png

Deprecation warning!

This field is deprecated and only available to documents in Standard Format, use psblock-[name] instead.

pslastediteddate

StoredIndexedData typeCardinalityAvailability
YesIndexeddatetime1..0icon-psstandard.pngPSML icon

The last time the document was edited. This only applies to psstandard documents after an edit was made.

Example:

"2012-03-31T14:21:04+10:00"

pslatestversion

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1..0icon-psstandard.pngPSML icon

The latest version version of the document available if the document has had a version.

Example:

"1.0"

psversionid

The id of the version - only set for version indexing.

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1..0icon-psstandard.pngPSML icon

psstatus

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1All except comment and folder.

The latest status of the document or task.

Examples:

"Open"
"Closed"

psstatuschangeddate

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..1All except comment and folder.

pspriority

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..1All except comment and folder.

The latest priority of the task or document

Examples:

"High"
"Low"

psassignedto

StoredIndexedData typeCardinalityAvailability
YesIndexedtext1All except comment and folder.

The full name of the person the task or document was assigned to.

Example:

"John Smith"

psassignedtoid

StoredIndexedData typeCardinalityAvailability
YesIndexedlong0..1All except comment and folder.

The member ID of the person the task or document was assigned to.

Example:

123

psduedate

StoredIndexedData typeCardinalityAvailability
YesAnalyzeddatetime0..1All except comment and folder.

The date the task or document is due.

Example:

"2012-07-06T19:00:00+11:00"

psdiscussionid

StoredIndexedData typeCardinalityAvailability
YesIndexedlong1Comment icon

The ID of the comment discussion.

Example:

"123"

pstaskdefinitionid

StoredIndexedData typeCardinalityAvailability
YesIndexedlong1Task icon

The ID of the task definition comment. This is the latest comment in the task with status="Open" and previous status not "Open". The following fields take their values from the definition comment: pssubtype, pslabels, pscreateddate, psauthor, ps-description.

Example:

"123"

psauthor

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..1Task iconComment icon

The psauthor is the full name of the person who posted a comment or task. If the member changes their name, that will only be reflected in items posted after the name was changed.

Example:

John Smith

psauthorid

StoredIndexedData typeCardinalityAvailability
YesIndexedlong0..1Task iconComment icon

The psauthorid is the member ID of the person who posted a comment or task.

Example:

123

pswidth

StoredIndexedData typeCardinalityAvailability
YesIndexedint0..1Image icon

The pswidth is the width in pixels of an image. This field is not always available inside an image.

Examples:

1024
800

psheight

StoredIndexedData typeCardinalityAvailability
YesIndexedint0..1Image icon

The psheight is the height in pixels of an image. The field is not always available inside an image.

Examples:

768
600

pspixelcount

StoredIndexedData typeCardinalityAvailability
NoIndexedtext0..1Image icon

The pspixelcount is the total number of pixels in an image calculated as psweight × psheight. It is only available if both the width and height are available for the image

Examples:

786432
48000

psgraphicsrc

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..Nicon-psstandard.png

Each psgraphicsrc field instance contains the value of the source of an image in a standard document. There should be as many field instances are there are images in the document.

Deprecation warning!

This field is deprecated and is not available for PSML documents, it has been replaced by psimagesrc to be inline with PSML markup.

Example:

"/ps/acme/test/Images/sample.png"

psimagesrc

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..Nicon-psstandard.pngPSML icon

Each psimagesrc field instance contains the value of the source an image in a PSML document. There should be as many field instances are there are images in the document.

Example:

"/ps/acme/test/Images/sample.png"

psxrefcount

StoredIndexedData typeCardinalityAvailability
YesIndexedint1All except comment, task and folder.

Each psxrefcount field is the total number of forward (outgoing) XRefs in the document.

Example:

12

psreversexrefcount

StoredIndexedData typeCardinalityAvailability
YesIndexedint1All except comment, task and folder.

Each psreversxrefcount field is the total number of reverse (incoming) XRefs in the document.

Example:

12

psxreflabel

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..NAll except comment, task and folder.

Each psxreflabel field represents a label on a forward (outgoing) XRef in the document.

Example:

important

psreversexreflabel

StoredIndexedData typeCardinalityAvailability
YesIndexedtext0..NAll except comment, task and folder.

Each psreversexreflabel field represents a label on a reverse (incoming) XRef in the document.

Example:

important

Created on , last edited on