OmniDocs Component Configuration

All the components of Omnidocs engine can be configured using a function which takes an input XML and writes it on a socket to the specified IP and port. The input XML can be any configuration XML for any of the omnidocs components. Each of the omnidocs components accepts an input configuration XML and configures itself to the values specified in the XML. The IP and port in the function specify the IP and port on which the component is running.

Package

com.newgen.dmsconfigapi

Class Name

DMSConfig

Prototype

public String configureOmnidocs	(	String strInputXML,
		String strIPAddress,
		int nPort
	)

Input Parameters

Name	Description
strInputXML	The input XML to be sent to omnidocs component that has to be configured.
strIpAddress	The IP address of the machine on which the component is running.
NPort	The port on which the component is listening.

Return Values

A single value, which contains response of the function in the form of XML

Following are the operations for various components of OmniDocs Engine that can be performed throught the function described above.

Java Transaction Server

Configuration Option	Description
StartServer	Start client socket so that ODTS can serve the clients
StopServer	Stops Client Socket so that ODTS can not serve clients
AssociateCabinet	Registers a new cabinet on ODTS.
DissociateCabinet	Unregisters a cabinet on ODTS.
ChangeCabinetProperty	Change properties of an associated cabinet
ChangeServerProperty	Changes Server property.
GetCabinetList	Gets all associated cabinets
GetCabinetProperty	Gets a property of associated cabinet.
GetServerProperty	Gets server property.
TestCabinet	Tests associated cabinet.
TestClientSocket	Test whether ODTS is running or not.
CreateCabinet	Creates a new omnidocs cabinet.
DeleteCabinet	Deletes a cabinet.
GetListOfLoginUsers	Get currently logged in users.
DisconnectUsers	Dissconect logged in users.
Compile	Compile all procedure to a selected cabinet.

SMS

Configuration Option	Description
StartServer	Starts SMS
StopServer	Stops SMS
SetServerProperty	Set SMS server Property
GetServerProperty	Gets Server Property

Thumbnail Manager

Configuration Option	Description
Shutdown	Stops Thumbnail Manager.
GetThumbnailMgrProperty	Get Thumbnail Manager properties.
ChangeThumbnailMgrProperty	Set Thumbnail Manager Properties.
Restart	Reloads the configuration file and restarts the Thumbnail Manager.
AddCabinet	Adds a cabinet in the configuration file to be scheduled for thumbnail generation.
RemoveCabinet	Removes a cabinet from the configuration file.