ArchiveServer Class Reference

The ArchiveServer class has been added to the DOCUMENTS PortalScripting API to gain full access to the DOCUMENTS ArchiveServer by scripting means. More...

Public Member Functions
ArchiveConnection	getArchiveConnection ()
	Retrieve the archive connection object for EAS, EBIS or EASY Enterprise XML-Server. More...
String	getAttribute (String attribute)
	Get the String value of an attribute of the ArchiveServer. More...
String	getLastError ()
	If you call a method at an ArchiveServer object and an error occurred, you can get the error description with this function. More...
String	getOID (boolean oidLow=false)
	Returns the object-id. More...
boolean	setAttribute (String attribute, String value)
	Set the String value of an attribute of the ArchiveServer to the desired value. More...
void	submitChanges ()
	After changes on the ArchiveServer with scripting methods, it is necessary to submit them to make them immediately valid. More...

Public Attributes
String	name
	The technical name of the ArchiveServer. More...

Detailed Description

The ArchiveServer class has been added to the DOCUMENTS PortalScripting API to gain full access to the DOCUMENTS ArchiveServer by scripting means.

Since

DOCUMENTS 5.0a

Member Function Documentation

getArchiveConnection()

ArchiveConnection ArchiveServer::getArchiveConnection

(

)

Retrieve the archive connection object for EAS, EBIS or EASY Enterprise XML-Server.

The ArchiveConnection object can be used for low level call directly on the archive interface.

Returns

ArchiveConnection object if successful, NULL in case of any error

Since

DOCUMENTS 5.0a

getAttribute()

String ArchiveServer::getAttribute

(

String

attribute

)

Get the String value of an attribute of the ArchiveServer.

Parameters

attribute

String containing the name of the desired attribute

Returns

String containing the value of the desired attribute

Note

This function is only for experts. Knowledge about the DOCUMENTS-database schema is necessary!

Since

DOCUMENTS 5.0a

getLastError()

String ArchiveServer::getLastError

(

)

If you call a method at an ArchiveServer object and an error occurred, you can get the error description with this function.

Returns

Text of the last error as String

Since

DOCUMENTS 5.0a

getOID()

String ArchiveServer::getOID

(

boolean

oidLow = false

)

Returns the object-id.

Parameters

oidLow

Optional flag: If true only the id of the ArchiveServer object (m_oid) will be returned. If false the id of the ArchiveServer object will be returned together with the id of the corresponding class in the form class-id:m_oid. The default value is false.

Returns

String with the object-id

Since

DOCUMENTS 5.0a

setAttribute()

boolean ArchiveServer::setAttribute	(	String	attribute,
		String	value
	)

Set the String value of an attribute of the ArchiveServer to the desired value.

Parameters

attribute	String containing the name of the desired attribute
value	String containing the desired value of the attribute

Returns

true if successful, false in case of any error

Note

This function is only for experts. Knowledge about the DOCUMENTS-database schema is necessary!

Since

DOCUMENTS 5.0a

submitChanges()

void ArchiveServer::submitChanges

(

)

After changes on the ArchiveServer with scripting methods, it is necessary to submit them to make them immediately valid.

The settings of the ArchiveServer will be cached in a connection pool to the archive system. The pool does not recognize changes in the ArchiveServer object automatically, therefore it is necessary to call this method after all.

Example:

var as = context.getArchiveServerByName("EDA_2017");
if (as)
{
  as.setAttribute("Host", "127.0.0.1");
  as.submitChanges();
}

Since

DOCUMENTS 5.0c

Member Data Documentation

name

String ArchiveServer::name

The technical name of the ArchiveServer.

Returns

String containing the technical name of the ArchiveServer.

Since

DOCUMENTS 5.0a