Coveo Knowledge Base – Information Article – 060331-1

PreConversion Object Reference

The information in this technical note applies to:

Coveo Enterprise Search 4

Summary

This document contains complementary information about the PreConversion scripting object.

Definition
Overview
Properties
Methods

Definition

The PreConversion scripting object contains multiple useful properties and methods to manage the conversion of a document.

Overview

This is a list of all PreConversion properties and methods.

· Properties: InputDocument

· Methods: DeleteFile, GetGlobalVariable, SetGlobalVariable, GetParameter, Sleep, Trace

Properties

Name	Type	Description	Read-only State
InputDocument	BinaryData	Returns the data of the document.	Read-only

Methods

Name	Type	Description	Parameters
DeleteFile		Deletes a file.	p_FileName (String): The file name to delete.
GetGlobalVariable	Variant	Retrieve a value for a global variable.	p_Name (String): The global variable name to get.
SetGlobalVariable		Sets a value for a global variable.	p_Name (String): The global variable name to set. p_Value (Variant): The global variable value to set.
GetParameter	String	Retrieve a value for a parameter.	p_Name (String): The parameter name to get.
Sleep		Blocks the current thread for the specified number of milliseconds.	p_MilliSeconds (Long): The number of milliseconds to sleep.
Trace		Outputs a message to the tracing utility (CES console).	p_Message (String): The message to output. p_Severity (SeverityEnumeration enum): The message severity.

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