XMLExportDescription Class Reference

The XMLExportDescription class has been added to the DOCUMENTS PortalScripting API to improve the XML Export process of DOCUMENTS files by scripting means. More...

Public Member Functions
XMLExportDescription	XMLExportDescription ()
	Create a new XMLExportDescription object. More...

Public Attributes
boolean	exportCreatedAt
	boolean value whether export the create timestamp of the file. More...
boolean	exportFileId
	boolean value whether export the id of the file. More...
boolean	exportLastModifiedAt
	boolean value whether export the timestamp of the last modification of the file. More...
boolean	exportLastModifiedBy
	boolean value whether export the name of the last editor of the file. More...
boolean	exportOwner
	boolean value whether export the name of the owner of the file. More...

Detailed Description

The XMLExportDescription class has been added to the DOCUMENTS PortalScripting API to improve the XML Export process of DOCUMENTS files by scripting means.

For instance this allows to use different target archives for each file as well as to influence the archiving process by the file's contents itself. The XMLExportDescription object can only be used as parameter for the method XMLExport.addFile(XMLExportDescription)

Since

DOCUMENTS 4.0c

Constructor & Destructor Documentation

XMLExportDescription()

XMLExportDescription XMLExportDescription::XMLExportDescription

(

)

Create a new XMLExportDescription object.

Like in other programming languages you create a new object with the new operator (refer to example below).

Returns

XMLExportDescription which allows to define several conditions for the archiving process of a certain DocFile object

Since

DOCUMENTS 4.0c

Example:

var docFile = context.file;
if (!docFile)
{
   // error handling
}

var desc = new XMLExportDescription();
desc.exportFileId = true;
desc.exportOwner = true;
desc.exportLastModifiedBy = true;
desc.exportCreatedAt = true;
desc.exportLastModifiedAt = true;

// create a new XMLExport
var xml = new XMLExport("c:\\tmp\\" + docFile.getAutoText("id") + ".xml");
xml.addFile(docFile, desc); // add the current file to the export
xml.saveXML(); // perform the export operation

See also

XMLExport.addFile()

Member Data Documentation

exportCreatedAt

boolean XMLExportDescription::exportCreatedAt

boolean value whether export the create timestamp of the file.

Since

DOCUMENTS 4.0c

exportFileId

boolean XMLExportDescription::exportFileId

boolean value whether export the id of the file.

Since

DOCUMENTS 4.0c

exportLastModifiedAt

boolean XMLExportDescription::exportLastModifiedAt

boolean value whether export the timestamp of the last modification of the file.

Since

DOCUMENTS 4.0c

exportLastModifiedBy

boolean XMLExportDescription::exportLastModifiedBy

boolean value whether export the name of the last editor of the file.

Since

DOCUMENTS 4.0c

exportOwner

boolean XMLExportDescription::exportOwner

boolean value whether export the name of the owner of the file.

Since

DOCUMENTS 4.0c