Java Transaction Server

This section defines the XML details for changing and retrieving the configuration of Transaction server.

StartServer

This XML starts the JTS server on the IP and port specified in the configuration file of JTS.

Input XML description	View sample InputXml
Output XML description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	StartServer

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.

Stop Server

This XML stops the JTS server.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	StopServer

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.

Associate cabinet

This XML associates a database cabinet with the JTS.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	Associate Cabinet
CabinetInfo	Root	Contains information about the cabinet that is to be associated.
CabinetName	CabinetInfo	Name of the cabinet that is to be associated.	Any valid string.
UserName	CabinetInfo	User name with which to connect to the database server.	Any valid string.
USerPassword	CabinetInfo	The password corresponding to the username for connecting to database server.	Any valid string.
MaxDB Connections	CabinetInfo	Maximum connection that JTS will maintain with the cabinet at any point of time.	Any integer >0
MinDB Connections	CabinetInfo	The minimum number of connections with the database cabinet that the JTS will always retain.	Any integer >0 and < MaxDB Connections.
Querytimeout	CabinetInfo	Maximum time for which the JTS will wait for the results of a query. If set to 0 JTS will wait forever.	Any integer >=0.
CabinetType	CabinetInfo	Type of cabinet to be created i.e. Document Cabinet or image cabinet or both.	I – Image database. D – document database. B – Both.
DatabaseType	CabinetInfo	The database server on which the cabinet exists.	postgres oracle mssql
IP	CabinetInfo	IP of the database server.	Any valid IP.
Port	CabinetInfo	Port on which the database server is listening.	Any Integer>0
Service	CabinetInfo	Service name (Valid only for Oracle database)	Service name incase of Oracle database, empty otherwise.

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.

DissociateCabinet

This XML dissociates a cabinet from JTS.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	Dissociate Cabinet
CabinetInfo	Root	Contains Information about the cabinet that is to be dissociated.
CabinetName	CabinetInfo	Name of the cabinet that is to be dissociated.	Any valid string.

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.

ChangeCabinetProperty

This XML changes the properties of an associated cabinet.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	ChangeCabinet Property
CabinetInfo	Root	Contains information about the cabinet whose properties have to be changed.
CabinetName	CabinetInfo	Name of the cabinet whose properties have to be changed.	Any valid string.
UserName	CabinetInfo	User name with which to connect to the database server.	Any valid string.
USerPassword	CabinetInfo	The password corresponding to the username for connecting to database server.	Any valid string.
MaxDB Connections	CabinetInfo	Maximum connection that JTS will maintain with the cabinet at any point of time.	Any integer >0
MinDB Connections	CabinetInfo	The minimum number of connections with the database cabinet that the JTS will always retain.	Any integer >0 and < MaxDB Connections.
Querytimeout	CabinetInfo	Maximum time for which the JTS will wait for the results of a query. If set to 0 JTS will wait forever.	Any integer >=0.
CabinetType	CabinetInfo	Type of cabinet i.e. Document Cabinet or image cabinet or both.	I – Image database. D – document database. B – Both.
DatabaseType	CabinetInfo	The database server on which the cabinet exists.	postgres – Postgre database. oracle – Oracle database mssql – Microsoft SQL database
DriverName	CabinetInfo	Driver name with which to connect to database.
DriverURL	CabinetInfo	The database URL corresponding to the cabinet.

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.

TestCabinet

This XML tests the associated cabinet.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	TestCabinet
CabinetInfo	Root	Information about the associated cabinet that has to be tested.
CabinetName	CabinetInfo	Name of the cabinet that has to be tested.	Any valid string.

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.

GetServerProperty

This XML fetches the JTS properties like the IP and port on which the JTS is running.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	GetCabinetList

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.
ServerInfo	Root	Information about the JTS.
ServerPort	ServerInfo	Port on which JTS is listening.
SocketTimeout	ServerInfo	Socket timeout for JTS.
BatchSize	ServerInfo	Default batch size to be used for calls returning list of results. For eg: NGOGetDocumentList

GetCabinetList

This XML fetches the list of cabinets that have been associated with the JTS.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	GetCabinetList

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.
CabinetList	Root	Contains the list of cabinets.
CabinetInfo	cabinetList	Contains Information about one cabinet.
CabinetName	CabinetInfo	Name of the cabinet.
UserName	CabinetInfo	User name with which to connect to the database server.
UserPassword	CabinetInfo	Password of the user with which to login to the database.
DriverName	CabinetInfo	Name of the driver with which the connection to database is to be made.
DriverURL	CabinetInfo	The database URL corresponding to the cabinet.
MaxDBConnections	CabinetInfo	Maximum connection that JTS will maintain with the cabinet at any point of time.
MinDBConnections	CabinetInfo	The minimum number of connections with the database cabinet that the JTS will always retain.
Querytimeout	CabinetInfo	Maximum time for which the JTS will wait for the results of a query. If set to 0 JTS will wait forever.
CabinetType	CabinetInfo	Type of cabinet i.e. Document Cabinet or image cabinet or both.
DatabaseType	CabinetInfo	The database server on which the cabinet exists.

ChangeServerProperty

This XML changes the server properties to values specified in the XML.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	ChangeServer Property
ServerInfo	Root	Information about the JTS.
ServerPort	ServerInfo	The port on which the JTS will listen.	Any Integer>0
SocketTimeout	ServerInfo	Socket timeout for JTS.	Any integer>=0
BatchSize	ServerInfo	Default batch size to be used for calls returning list of results. For eg: NGOGetDocumentList	Any Integer>0
TransactionLog	ServerInfo	specifies whether transaction log would be generated or not.	true – if log is to be generated false – if log is not to be generated.
ConnectionLog	ServerInfo	specifies whether connection log would be generated or not.	true – if log is to be generated false – if log is not to be generated.

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the call is successful.

TestClientSocket

This XML tests whether JTS is running or not.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	TestClientSocket

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the JTS is running.

CreateCabinet

OmniDocs Cabinet Creation is the first step of using OmniDocs. Cabinet is a place where most of the business logic and data structure of System resides. This XML creates a database cabinet with the specified attributes.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	CreateCabinet
CabinetName	Root	Name of the cabinet to be created.	Any valid string.
CabinetType	Root	Type of cabinet to be created i.e. Document Cabinet or image cabinet or both.	I – Image database. D – document database. B – Both.
AutoVersion	Root	Indicates Auto Versioning for the Cabinet. AutoVersioning ‘Yes’ for a document implies that whenever the document is Checked In or Annotations are added / modified / deleted or image of document is changed, then a new Version of the document is created automatically. AutoVersioning ‘No’ for a document implies that creation of a new Version is done only when an explicit call is made.  Recommended Auto Versioning is ‘Yes’.	Y – yes N - no
EnableFts	Root	Specifies whether FTS is to be enabled on the database or not. FTS is not available in this version of the engine.	N – no
SecurityLevel	Root	This is the Security Level of the Cabinet . Its various options are: §   None - No Security. No Rights validation is done for any User. § Cabinet Access - Cabinet Level Security that is, a User who has Rights on Cabinet has similar Rights on all objects. § Document Access - Object Level Security. Rights validation on each Object is done. User can be granted Rights on documents, folders, etc and Rights validation is done to ensure that the User has required Rights before he can perform any operation on the Object. Recommended Security Level is ‘Document Access’.
Database	Root	Information regarding the database server on which the database cabinet is to be created.
IP	Database	IP address of the database server on which the database will be created.	Any valid IP Address.
Port	Database	The port on which the database server is listening.	Any Integer >0
UserName	Database	The username with which to connect to the database server.	Any valid string.
UserPassword	Database	The password corresponding to the user name for logging into the database server.	Any valid string.
PhysicalLocation	Database	The physical location where the actual database is created.
DatabaseType	CabinetInfo	The database server on which the cabinet exists.	postgres oracle mssql
LogSize	Database	Size of the Log file that is generated.

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	The status code of the result.

GetCabinetProperty

This XML retrieves the property of the specified cabinet.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	GetCabinet Property
CabinetInfo	Root	Information about the cabinet whose properties have to be retrieved.
CabinetName	CabinetInfo	Name of the cabinet whose properties have to be retrieved.	Any valid string.

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the JTS is running.
CabinetInfo	cabinetList	Contains Information about one cabinet.
CabinetName	CabinetInfo	Name of the cabinet.
UserName	CabinetInfo	User name with which to connect to the database server.
UserPassword	CabinetInfo	Password of the user with which to login to the database.
DriverName	CabinetInfo	Name of the driver with which the connection to database is to be made.
DriverURL	CabinetInfo	The database URL corresponding to the cabinet.
MaxDBConnections	CabinetInfo	Maximum connection that JTS will maintain with the cabinet at any point of time.
MinDBConnections	CabinetInfo	The minimum number of connections with the database cabinet that the JTS will always retain.
Querytimeout	CabinetInfo	Maximum time for which the JTS will wait for the results of a query. If set to 0 JTS will wait forever.
CabinetType	CabinetInfo	Type of cabinet i.e. Document Cabinet or image cabinet or both.
DatabaseType	CabinetInfo	The database server on which the cabinet exists.

GetListOfLoginUsers

This XML returns the list of users logged in to a particular cabinet.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	GetListOfLoginUsers
UserName	Root	Username with which to login to the cabinet.	Any valid string.
Password	Root	The password for the user with which to login to the cabinet.	Any valid string.
CabinetName	Root	The name of the cabinet whose list of logged in users is to be retreived.	Any valid string.

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the JTS is running.
Users	Root	Contains the list of logged in users.
User	Users	Contains information about a particular logged in user.
UserIndex	User	The user index of the logged in user.
UserName	User	Name of the logged in user.
UserDBId	User	User DB id of the user who is logged in.
HostName	User	Host name of the machine from which the logged in user is connected to the cabinet.

DisconnectUsers

This XML disconnects the specified users from the database cabinet. Only supervisor can disconnect other users.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	DisconnectUsers
UserName	Root	Username of the supervisor of the cabinet.	Any valid string.
Password	Root	The password of the supervisor user of the cabinet.	Any valid string.
CabinetName	Root	The name of the cabinet whose users have to be disconnected.	Any valid string.
Users	Root	List of users to be disconnected.
User	Users	Information about a particular user that is being disconnected.
UserDBId	User	The User DB id of the connected user who is to be disconnected.	Any Integer.
HostName	User	Host name of the machine from which the user to be disconnected is connected to the cabinet.	Any valid IP.

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the JTS is running.

DeleteCabinet

This XML deletes the specified cabinet from the database.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	DeleteCabinet
CabinetName	Root	Name of the cabinet that is to be deleted.	Any valid string.
IP	Root	IP of the database base server.	Any valid IP.
Port	Root	Port on which the database server is listening.	Any Integer>0
UserName	Root	User name of the supervisor of cabinet to be deleted.	Any valid string.
UserPassword	Root	password of the supervisor user.	Any valid string.
DatabaseType	CabinetInfo	The database server on which the cabinet exists.	postgres oracle mssql

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the JTS is running.

Compile

This XML compiles all the stored procedures on the cabinet.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input XML

Name	Parent Tag	Description	Valid Values
AdminOption	Root	Unique option for the call.	Compile
CabinetInfo	Root	Information about the cabinet on which the procedures have to be compiled.
CabinetName	CabinetInfo	Name of the cabinet on which the procedures have to be compiled.	Any valid string.
CabinetType	CabinetInfo	Type of cabinet on which the procedures have to be compiled.	I – Image database. D – document database. B – Both.

Output XML

Name	Parent Tag	Description
AdminOption	Root	Unique option for the call.
Status	Root	Status of the call. If it is 0, then the JTS is running.