SetOutputExpireDate

Syntax

SetOutputExpireDate(str);

str

A string value in one of the following formats: • Digits – The digits represent an offset in number of days. This offset is added to the CreationDateTime of the document to create the ExpiringDateTime. • An ISO 8601 duration (date part only) – The duration is added to the CreationDateTime of the document to create the ExpiringDateTime.

Description

Sets an expiring date at which a document in the Collector archive is expired and ready to be deleted. The offset is set from the time at which the document is created in the output queue.

The function can be used at the following scripting levels:

•	Before job – The expiring date is set for all documents included in the job.

•	Before Message – The expiring date is set for all documents included in the Message.

•	Before Process – The expiring date is set for each document created from the Process.

The scripting levels can be combined. For example, to set a default expiring date for all documents included in a job and at the same time override this expiring date for specific documents.

The actual deletion of the expired documents must be scheduled and performed separately. For more information, see the OpenText StreamServe Database Guidelines Reference Guide for the database vendor.

Returns

	An expiring date was set.
-1	Error – Invalid date parameter.
-2	Error – Negative date parameter.
-3	Error – Other.
	The current job is not using queues.

Example

SetOutputExpireDate("500"); 
\\ Deletes the document after 500 days

Example

SetOutputExpireDate("P1Y2M3D");
\\ Deletes the document after one year, two months, and three days