Coveo Knowledge Base – Information Article – 060331-1

DocumentInfo Object Reference

The information in this technical note applies to:

Coveo Enterprise Search 4

Summary

This document contains complementary information about the DocumentInfo scripting object.

Definition
Overview
Properties
Methods

Definition

The DocumentInfo scripting object contains multiple useful properties and methods to manipulate a document properties.

Overview

This is a list of all DocumentInfo properties and methods.

· Properties: AddedDate, Author, Changes, ClickableURI, Collection, CustomWeight, Date, Extension, Fields, FileType, IsValid, PhysicalIndex, PrintableURI, RetrievedDate, Source, SummaryConcepts, SummarySentences, Title, URI

· Methods: GetFieldValue, SetFieldValue

Properties

Name	Type	Description	Read-only State
AddedDate	Date	The date when the document was added for the first time.	Read-only
Author	String	The author of the document.	Read / Write
Changes	Unsigned integer	Get the list of changes made to the object.	Read-only
ClickableURI	String	The clickable URI of the document.	Read / Write
Collection	String	The collection name of the document.	Read-only
CustomWeight	Unsigned integer	The custom ranking weight of the document.	Read / Write
Date	Date	The date of the document.	Read / Write
Extension	String	The Extension of the document.	Read-only
Fields	Variant Array	The meta fields of the document.	Read-only
FileType	String	The file type of the document.	Read / Write
IsValid	Boolean	Property specifying whether the document is valid or not.	Read / Write
PhysicalIndex	String	The Physical Index name of the document.	Read-only
PrintableURI	String	The printable URI of the document.	Read / Write
RetrievedDate	Date	The date when the document was retrieved.	Read-only
Source	String	The source name of the document.	Read-only
SummaryConcepts	Variant Array	The summary concepts of the document.	Read / Write
SummarySentences	Variant Array	The summary sentences of the document.	Read / Write
Title	String	The title of the document.	Read / Write
URI	String	The URI of the document.	Read-only

Methods

Name	Type	Description	Parameters
GetFieldValue	Variant	Retrieve a value for a meta field.	p_pFieldName (String): The field name to get.
SetFieldValue		Sets a value for a meta field.	p_pFieldName (String): The field name to set. p_Value (Variant): The field value to set.

See Conversion Script Objects Reference to get a complete list of all available conversion script objects.