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. The  primary tools for adding custom semantics to the index are document types and labels.

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

Media-specific

Fields details

psancestor

Stored	Indexed	Data type	Cardinality	Availability
No	Indexed	text	1..N	(All except URL)

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"

psassignedto

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	( All except comment and folder)

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

Example:

"John Smith"

psassignedtoid

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	long	0..1	( All except comment and folder)

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

Example:

123  

psauthor

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..1	(Task and comment)

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

Example:

John Smith

psauthorid

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	long	0..1	(Task and comment)

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

Example:

123  

psblock-[name]

Stored	Indexed	Data type	Cardinality	Availability
Compressed	Analyzed	text	0..N	(PSML only)

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

psblocklabelname

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	(PSML only)

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

Introduced in index version 5002 in PageSeeder version 5.9100.

pscomment-assignedto

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(Comment only)

The full name of the person the comment was assigned to.

Introduced in index version 5401 in PageSeeder version 5.9600.

Example:

"John Smith"

pscomment-assignedtoid

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	long	0..1	(Comment only)

The member ID of the person the comment was assigned to.

Introduced in index version 5401 in PageSeeder version 5.9600.

Example:

123  

pscomment-duedate

Stored	Indexed	Data type	Cardinality	Availability
Yes	Analyzed	datetime	0..1	(Comment only)

The due date of the comment.

Introduced in index version 5401 in PageSeeder version 5.9600.

Example:

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

pscomment-priority

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..1	(Comment only)

The priority of the comment.

Introduced in index version 5401 in PageSeeder version 5.9600.

Examples:

"High"

"Low"

pscomment-status

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(Comment only)

The status of the comment.

Introduced in index version 5401 in PageSeeder version 5.9600.

Examples:

"Open"

"Closed"

pscontent

Stored	Indexed	Data type	Cardinality	Availability
Compressed	Tokenized	text	1	(All except images, folders and other files)

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. For URLs, the pscontent is the URL itself.

Example:

"An Alice said..."

pscontextexternal

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(Task and comment)

The pscontextexternal flag indicates id the comment/task context is an external URI (URL).

Introduced in index version 5405 in PageSeeder version 5.9900.

Example:

"true"

"false"

pscontextfragment

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(Task and comment)

The pscontextfragment is the URI fragment that a comment or task was posted on. If there was no specific fragment, it is default.

Example:

34   

details

pscontexturiid

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	long	1	(Task and comment)

The pscontexturiid is the ID of the URI a comment or task was posted on. If there was no URI (i.e. general context), it is 0.

Example:

123  

pscontexturititle

Stored	Indexed	Data type	Cardinality	Availability
Yes	Tokenized	text	0..1	(Task and comment)

The pscontexturititle is the title of the URI a comment or task was posted on.

Introduced in index version 9203 in PageSeeder version 6.0000.

Example:

"My document" 

pscontexturidocumenttype

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..1	(Task and comment)

The pscontexturidocumenttype is the document type of the URI a comment or task was posted on.

Introduced in index version 9203 in PageSeeder version 6.0000.

Example:

"appendix"

pscontexturimediatype

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..1	(Task and comment)

The pscontexturimediattype is the media typeof the URI a comment or task was posted on.

Introduced in index version 9203 in PageSeeder version 6.0000.

Example:

"image/png"  

pscontexturiurltype

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..1	(Task and comment)

The pscontexturiurltype is the title of the external URI a comment or task was posted on.

Introduced in index version 9203 in PageSeeder version 6.0000.

Example:

"youtube"  

pscreateddate

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	datetime	0..1	(ALL)

The date the document, comment or task was created or uploaded to PageSeeder.

Example:

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

psdescription

Stored	Indexed	Data type	Cardinality	Availability
Yes	Tokenized	text	1	(All except comment/task)

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 ..."

psdiscussionid

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	long	1	(Comment only)

The ID of the comment discussion.

Example:

"123"

psdocid

Stored	Indexed	Data type	Cardinality	Availability
Yes	Case insensitive	text	0..1	(All files, folders and URLs)

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.

Before PageSeeder v6 this field was tokenized.

Examples:

"ID-52634-GHG"

"PK771622"

psdocumenttype

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(PSML only)

The psdocumenttype field stores the document type of a document. If a document doesn’t have a document type, the value of this field is set to ‘none’ so documents which do not have a document type can be detected.

This field is only available to PSML documents.

Examples:

"component"

"book"

psduedate

Stored	Indexed	Data type	Cardinality	Availability
Yes	Analyzed	datetime	0..1	( All except comment and folder)

The date the task or document is due.

Example:

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

pseditable

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(PSML only)

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.

Examples:

"true"

"false"

psfilename

Stored	Indexed	Data type	Cardinality	Availability
Yes	Analyzed	text	1	(Files and folders)

The psfilename is name of the file corresponding to the document. This field is only available for documents and folders. To improve searching the following are tokenized:

• the file extension;
• any non-alphanumeric character, and;
• the “dot” as a separate word.

Examples:

"acme.xml"

"My Image.jpg"

psfolder

Stored	Indexed	Data type	Cardinality	Availability
Stored	Indexed	text	1	(Files and folders)

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"

psfragmentlabel

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	(PSML only)

Any fragment label(s) used in the document.

psfragmenttype

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(PSML only)

psgroupcount

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	int	1	(URLs only)

The number of groups containing a document with a link/xref to or discussion on this URL

Introduced in index version 5405 in PageSeeder version 5.9900.

Example:

3    

psgroupid

Stored	Indexed	Data type	Cardinality	Availability
Stored	Indexed	numeric	0..N	(ALL)

The psgroupid fields store the IDs of the context group(s) for the object. This field is indexed but not analyzed, so it’s not possible to search individual terms within each field value.

Introduced in index version 5005 in PageSeeder version 5.9400 and made numeric in version 6.0000.

Examples:

"123"

psgroupname

Stored	Indexed	Data type	Cardinality	Availability
Stored	Indexed	text	0..N	(ALL)

The psgroupname fields store the full names of the context group(s) for the object. This field is indexed but not analyzed, so it’s not possible to search individual terms within each field value.

Introduced in index version 5005 in PageSeeder version 5.9400.

Examples:

"acme-specs"

psheight

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	int	0..1	(Images only)

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

Examples:

768  

600  

pshost

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(URLs only)

The pshost field is the hostname of the URL (external URI).

Example:

"example.org"

psid

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(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

psimagelabel

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	( All except comment, task and folder)

Each psimagelabel field represents a label on an image in the document.

Introduced in index version 5405 in PageSeeder version 5.9900.

Example:

"screenshot"

psimagesrc

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	(PSML only)

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

Example:

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

psinline-[name]

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text/date	0..N	(PSML only)

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

If name ends with -date, it is indexed as a date and if it ends with -text, it is tokenized and case-insensitive. Currently only ISO format yyyy-mm-dd is supported for dates.

psinlinelabelname

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	(PSML only)

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

Introduced in index version 5402 in PageSeeder version 5.9700.

pslabel

Stored	Indexed	Data type	Cardinality	Availability
Stored	Indexed	text	0..N	(ALL)

The pslabel fields store verbatim, all labels applied to the item (document label, comment label, etc.). It doesn’t 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’s not possible to search individual terms within each field value.

Examples:

"test"

"bug"

"for_review"

pslastediteddate

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	datetime	1..0	(PSML only)

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

Example:

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

pslatestversion

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	( All except folder, comment and task)

The latest version of the document available, if the document has had a version (blank if no version).

Example:

"1.0"

pslatestversiondate

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	datetime	0..1	( All except folder, comment and task)

The created date for the latest version.

Introduced in index version 5007 in PageSeeder version 5.9501.

Example:

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

pslinklabel

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	( All except comment, task and folder)

Each pslinklabel field represents a label on an image in the document.

Introduced in index version 5405 in PageSeeder version 5.9900.

Example:

"video"

psmedia-createddate

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	datetime	0..1	(Word, PDF, PSML, Images)

The created date extracted from the binary file (different from the pscreateddate except for PSML documents).

Introduced in index version 5006 in PageSeeder version 5.9500.

Example:

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

psmedia-modifieddate

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	datetime	0..1	(Word, PDF, PSML, Images)

The modified date extracted from the binary file (different from the psmodifieddate except for PSML documents).

Introduced in index version 5006 in PageSeeder version 5.9500.

Example:

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

psmediatype

Stored	Indexed	Data type	Cardinality	Availability
Stored	Indexed	text	1	(ALL)

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

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

Icon	Media type
	application/vnd.pageseeder.folder
	application/word
	application/pdf
	text/html
	application/xml text/xml */*+xml
	application/vnd.pageseeder.psml+xml
	*/*
	image/*
	application/vnd.pageseeder.task+xml
	application/vnd.pageseeder.comment+xml

Examples:

"text/xml"

"image/png"

"application/vnd.pageseeder.comment+xml"

psmetadata-[name]

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text/date	0..N	(All files and URLs)

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

If name ends with -text, it is tokenized and case-insensitive.

psmetadataname

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	(All files and URLs)

The name(s) of any metadata properties used in the document.

Introduced in index version 9201 in PageSeeder version 6.0000.

psmetadatachecked

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	datetime	0..1	(URLs only)

The last date and time when the metadata was checked against the source URL for example by using the Reprocess option. The format is an ISO 8601 date and time and the resolution for the index is the second.

Introduced in index version 5405 in PageSeeder version 5.9900.

Example:

"2020-07-14T12:31:00+10:00"

psmodifieddate

Stored	Indexed	Data type	Cardinality	Availability
Stored	Indexed	datetime	1	(ALL)

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

Example:

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

psowned

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(All files and folders)

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

Introduced in index version 5002 in PageSeeder version 5.9100.

Examples:

"true"

"false"

pspagecount

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	int	1	(PDF only)

Each pspagecount field is the total number of pages in the PDF.

Introduced in index version 5005 in PageSeeder version 5.9400.

Example:

12   

pspixelcount

Stored	Indexed	Data type	Cardinality	Availability
No	Indexed	text	0..1	(Images only)

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

psprefixcontent

Stored	Indexed	Data type	Cardinality	Availability
Compressed	Tokenized except prefix	text	0..N	(PSML only)

This field contains heading or para content tokenized and any @prefix untokenized. It only contains para content when @prefix exists.

Introduced in index version 5403 in PageSeeder version 5.9800.

pspriority

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..1	( All except comment and folder)

The latest priority of the task or document.

Examples:

"High"

"Low"

psproperty-[name]

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text/date	0..N	(PSML, comment and task)

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

If name ends with -text, it is tokenized and case-insensitive.

pspropertyname

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	(PSML only)

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

Introduced in index version 9201 in PageSeeder version 6.0000.

pspublicationid

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	(PSML, task, comment)

This field only exists if the document, comment or task is part of a publication. It contains the ID of a publication.

Introduced in index version 5403 in PageSeeder version 5.9800.

pspublicationroot

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..1	(PSML only)

This field only exists if the document is the root of a publication and always has the value true.

Introduced in index version 5402 in PageSeeder version 5.9700.

psreversexrefcount

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	int	1	( All except comment, task and folder)

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

Example:

12   

psreversexreflabel

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	( All except comment, task and folder)

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

Example:

"important"

psreversexreftype

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	( All except comment, task and folder)

Each psreversexreftype field represents a forward type on a reverse (incoming) xref in the document.

Introduced in index version 6000 in PageSeeder version 6.0000.

Example:

"transclude"

psrootpublicationid

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..1	(PSML only)

This field only exists if the document is the root of a publication. It contains the ID of this publication.

Introduced in index version 5402 in PageSeeder version 5.9700.

pssize

Stored	Indexed	Data type	Cardinality	Availability
Yes	Analyzed	text	0..1	(All files except PSML)

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

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

Examples:

7013 

44986

pssource

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(URLs only)

The kind of URL source. Allowed values are external, virtual or pageseeder.

Introduced in index version 5405 in PageSeeder version 5.9900.

Example:

"virtual"

psstatus

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	( All except comment and folder)

The latest status of the document or task.

Examples:

"Open"

"Closed"

psstatuschangeddate

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..1	( All except comment and folder)

pssubtype

Stored	Indexed	Data type	Cardinality	Availability
Stored	Indexed	text	1	(ALL)

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

pstaskdefinitionid

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	long	1	(Task only)

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

Example:

"123"

pstitle

Stored	Indexed	Data type	Cardinality	Availability
Yes	Tokenized	text	1	(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 filename if no title was specified by the user.

Examples:

"Test Document"

"Important information"

pstitle-sort

Stored	Indexed	Data type	Cardinality	Availability
No	Tokenized	text	1	(ALL)

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

Examples:

"Test Document"

"Important information"

pstype

Stored	Indexed	Data type	Cardinality	Availability
Stored	Indexed	text	1	(ALL)

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

pstype	Description	icon(s)
folder	A URI which corresponds to a folder
document	A URI which corresponds to a document
documentversion	A version of a document (must have group property indexVersions=true )
url	A URL
fragment	A URI fragment	No longer supported
comment	A comment
task	A task

psurl

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(URLs only)

The psurl field is the full URL of the URL (external URI).

Example:

"http://example.org/test.html"

psurlmediatype

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..1	(URLs only)

The media type for the URL source.

Introduced in index version 5405 in PageSeeder version 5.9900.

Example:

"text/html"

psurltype

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1	(URLs only)

The configured type for this URL or default if there is no type.

Introduced in index version 5405 in PageSeeder version 5.9900.

Example:

"youtube"

psversionid

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

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	1..0	(PSML only)

pswidth

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	int	0..1	(Images only)

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

Examples:

1024 

800  

pswordcount

Stored	Indexed	Data type	Cardinality	Availability
Stored	Indexed	int	0..1	(All except images, folder and other files)

The pswordcount is the number of words (space separated characters) in the content.

Introduced in index version 5005 in PageSeeder version 5.9400.

Example:

123  

psxrefcount

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	int	1	( All except comment, task and folder)

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

Introduced in index version 5005 in PageSeeder version 5.9400.

Example:

12   

psxreflabel

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	( All except comment, task and folder)

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

Example:

"important"

psxreftype

Stored	Indexed	Data type	Cardinality	Availability
Yes	Indexed	text	0..N	( All except comment, task and folder)

Each psxreftype field represents a type on a forward (outgoing) xref in the document.

Introduced in index version 6000 in PageSeeder version 6.0000.

Example:

"transclude"