Configuration API

 

 

 OmniDocs Cabinet Configuration

 

This section provides sample Input and Output XML for Cabinet Creation and Configuration call which will create a new Cabinet and configure all the Components with it.

 

Input XML

 

<CabinetConfiguration_Input>

<JtsPort></JtsPort>

<SmsIp></SmsIp>

<SmsPort><SmsPort>

<ThumbNailManagerIp></ThumbNailManagerIp>

<ThumbNailManagerPort></ThumbNailManagerPort>

<CreateCabinet >

                <CabinetName></CabinetName>

                <CabinetType></CabinetType>

                <AutoVersion></AutoVersion>

                <EnableFts></EnableFts>

                <SecurityLevel></SecurityLevel>

                <MaxDBConnections>5</MaxDBConnections>

                <MinDBConnections>1</MinDBConnections>

                <Querytimeout>0</Querytimeout>

                <Service></Service>

                <Database>

                                <IP></IP>

                                <Port></Port>

                                <UserName></UserName>

                                <UserPassword></UserPassword>

                                <PhysicalLocation></PhysicalLocation>

                                <DataBaseType></DataBaseType>

                                <DatabaseSize></DatabaseSize>

                                <LogSize></LogSize>

                </Database>

</CreateCabinet >

<SMSServerProperty >

<Label>

                <LabelName>< /LabelName >

                <LabelPath>< /LabelPath >//only when flag is A or M

                <CreateDirFlag></ CreateDirFlag >//only when flag is A or M

</Label>

</SMSServerProperty >

</CabinetConfiguration_Input>

 

Output XML

 

<CabinetConfiguration_Output>

<Status></Status>

<ErrorMessage></ ErrorMessage >

</CabinetConfiguration_Output>

 

 

Java Transaction Server

 

This section provides sample  Input and Output XML for Java Transaction Server configuration operations.

 

StartServer

 

Input XML

 

<?xml version="1.0"?>

<StartServer_Input>

                <AdminOption>StartServer</AdminOption>

</StartServer_Input>

 

Output XML

 

<?xml version="1.0"?>

<StartServer_Output>

<AdminOption>StartServer</AdminOption>

                <Status>0</Status>

</StartServer_Output>

 

 

Stop Server

 

Input XML

 

<?xml version="1.0"?>

<StopServer_Input>

                <AdminOption>StopServer</AdminOption>

</StopServer_Input>

 

Output XML

 

<?xml version="1.0"?>

<StopServer_Output>

<AdminOption>StopServer</AdminOption>

                <Status>0</Status>

</StopServer_Output>

 

 

Associate Cabinet

 

Input XML

 

<?xml version="1.0"?>

<AssociateCabinet_Input>

                <AdminOption>AssociateCabinet</AdminOption>

                <CabinetInfo>

                                <CabinetName>second</CabinetName>    

                                <UserName>sa</UserName>

                                <USerPassword></UserPassword>

                                <MaxDBConnections>5</MaxDBConnections>

                                <MinDBConnections>1</MinDBConnections>

                                <Querytimeout>0</Querytimeout>

                                <CabinetType>B</CabinetType> 

                                <DatabaseType>mssql</DatabaseType>

                                <IP>abacus</IP>

                                <Port></Port>

                                <Service></Service>

                </CabinetInfo>

</AssociateCabinet_Input>

 

Output XML

 

<?xml version="1.0"?>

<AssociateCabinet_Output>

                <AdminOption>AssociateCabinet</AdminOption>

                <Status>0</Status>

</AssociateCabinet_Output>

 

 

DissociateCabinet

 

Input XML

 

<?xml version="1.0"?>

<DissociateCabinet_Input>

<AdminOption>DissociateCabinet</AdminOption>

                <CabinetInfo>

                                <CabinetName>first</CabinetName>           

                </CabinetInfo>

</DissociateCabinet_Input>

 

Output XML

 

<?xml version="1.0"?>

<DissociateCabinet_Output>

                <AdminOption>DissociateCabinet</AdminOption>

                <Status>0</Status>

</DissociateCabinet_Output>

 

ChangeCabinetProperty

 

Input XML

 

<?xml version="1.0"?>

                <ChangeCabinetProperty_Input>

                <AdminOption>ChangeCabinetProperty</AdminOption>

                <CabinetInfo>

                                <CabinetName>dec22sql</CabinetName>

                                <UserName>sa</UserName>

                                <USerPassword></UserPassword>

                                <DriverName>sun.jdbc.odbc.JdbcOdbcDriver</DriverName>

                                <DriverURL>jdbc:odbc:dec22sql</DriverURL>

                                <MaxDBConnections>50</MaxDBConnections>

                                <MinDBConnections>1</MinDBConnections>

                                <Querytimeout>300</Querytimeout>

                                <CabinetType>B</CabinetType> 

                                <DatabaseType>mssql</DatabaseType>

                </CabinetInfo>

</ChangeCabinetProperty_Input>

 

Output XML

 

<?xml version="1.0"?>

<ChangeCabinetProperty_Output>

<AdminOption>ChangeCabinetProperty</AdminOption>

                <Status>0</Status>

</ChangeCabinetProperty_Output>

 

TestCabinet

 

Input XML

 

<?xml version="1.0"?>

<TestCabinet_Input>

                <AdminOption>TestCabinet</AdminOption>

                <CabinetInfo>

                                <CabinetName>first</CabinetName>

                <CabinetInfo>

</TestCabinet_Input>

 

Output XML

 

<?xml version="1.0"?>

<TestCabinet_Output>

                <AdminOption>TestCabinet</AdminOption>

                <Status>0</Status>

</TestCabinet_Output>

 

GetServerProperty

 

Input XML

 

<?xml version="1.0"?>

<GetServerProperty_Input>

                <AdminOption>GetServerProperty</AdminOption>

</GetServerProperty_Input>

 

Output XML

 

<?xml version="1.0"?>

<GetServerProperty_Output>

                <AdminOption>GetServerProperty</AdminOption>

                <Status>0</Status>

                <ServerInfo>

                                <ServerPort>3333</ServerPort>

                                <SocketTimeout>600</SocketTimeout>

                                <BatchSize>5000</BatchSize>

                </ServerInfo>

</GetServerProperty_Output>

 

 

GetCabinetList

 

Input XML

 

<?xml version="1.0"?>

<GetCabinetList_Input>

                <AdminOption>GetCabinetList</AdminOption>

</GetCabinetList_Input>

 

Output XML

 

<?xml version="1.0"?>

<GetCabinetList_Output>

                <AdminOption>GetCabinetList</AdminOption>

                <Status>0</Status>

<CabinetList>

                                <CabinetInfo>

                                                <CabinetName>third</CabinetName>

                                                <UserName>sa</UserName>

                                                <UserPassword></UserPassword>

                                                <DriverName>sun.jdbc.odbc.JdbcOdbcDriver</DriverName>

                                                <DriverURL>jdbc:odbc:first</DriverURL>

                                                <MaxDBConnections>5</MaxDBConnections>

                                                <MinDBConnections>1</MinDBConnections>

                                                <Querytimeout>3</Querytimeout>

                                                <CabinetType>B</CabinetType>

                                                <DatabaseType>mssql</DatabaseType>

                                </CabinetInfo>

                                <CabinetInfo>

                                                <CabinetName>first</CabinetName>

                                                <UserName>sa</UserName>

                                                <UserPassword></UserPassword>

                                                <DriverName>sun.jdbc.odbc.JdbcOdbcDriver</DriverName>

                                                <DriverURL>jdbc:odbc:first</DriverURL>

                                                <MaxDBConnections>5</MaxDBConnections>

                                                <MinDBConnections>1</MinDBConnections>

                                                <Querytimeout>3</Querytimeout>

                                                <CabinetType>B</CabinetType>

                                                <DatabaseType>mssql</DatabaseType>

                                </CabinetInfo>

                </CabinetList>

</GetCabinetList_Output>

 

ChangeServerProperty

 

Input XML

 

<?xml version="1.0"?>

<ChangeServerProperty_Input>

                <AdminOption>ChangeServerProperty</AdminOption>

                <ServerInfo>

                                <ServerPort>3333</ServerPort>

                                <SocketTimeout>600</SocketTimeout>

                                <BatchSize>5000</BatchSize>

                                <TransactionLog>true</TransactionLog>

                                <ConnectionLog>true</ConnectionLog>

                </ServerInfo>

                </ChangeServerProperty_Input>

 

Output XML

 

<?xml version="1.0"?>

<ChangeServerProperty_Output>

                <AdminOption>ChangeServerProperty</AdminOption>

                <Status>0</Status>

</ChangeServerProperty_Output>

 

 

TestClientSocket

 

Input XML

 

<?xml version="1.0"?>

<TestClientSocket_Input>

                <AdminOption>TestClientSocket</AdminOption>

</TestClientSocket_Input>

 

Output XML

 

<?xml version="1.0"?>

<TestClientSocket_Output>

                <AdminOption>TestClientSocket</AdminOption>

                <Status>0</Status>

</TestClientSocket_Output>

 

 

CreateCabinet

 

Input XML

 

<?xml version="1.0"?>

<CreateCabinet_Input>

<AdminOption>CreateCabinet</AdminOption>

                <CabinetName></CabinetName>

                <CabinetType></CabinetType>

                <AutoVersion></AutoVersion>

                <EnableFts></EnableFts>

                <SecurityLevel></SecurityLevel>

                <Database>

                                <IP></IP>

                                <Port></Port>

                                <UserName></UserName>

                                <UserPassword></UserPassword>

                                <PhysicalLocation></PhysicalLocation>

                                <DataBaseType></DataBaseType>

                                <DatabaseSize></DatabaseSize>

                                <LogSize></LogSize>

                </Database>

</CreateCabinet_Input>

 

Output XML

 

<?xml version="1.0"?>

<CreateCabinet_Output>

                <AdminOption>CreateCabinet</AdminOption>

                <Status>0</Status>

</CreateCabinet_Output>

 

 

GetCabinetProperty

 

Input XML

 

<?xml version="1.0"?>

<GetCabinetProperty_Input>

                <AdminOption>GetCabinetProperty</AdminOption>

                <CabinetInfo>

                                <CabinetName>first</CabinetName>           

                </CabinetInfo>

</GetCabinetProperty_Input>

 

Output XML

 

<?xml version="1.0"?>

<GetCabinetProperty_Output>

                <AdminOption>GetCabinetProperty</AdminOption>

                <Status>0</Status>

                <CabinetInfo>

                                <CabinetName>first</CabinetName>           

                                <UserName>sa</UserName>

                                <USerPassword></UserPassword>

                                <DriverName>sun.jdbc.odbc.JdbcOdbcDriver</DriverName>

                                <DriverURL>jdbc:odbc:first</DriverURL>

                                <MaxDBConnections>50</MaxDBConnections>

                                <MinDBConnections>1</MinDBConnections>

                                <Querytimeout>300</Querytimeout>

                                <CabinetType>B</CabinetType> 

                                <DatabaseType>mssql</DatabaseType>

                </CabinetInfo>

</GetCabinetProperty_Output>

 

 

GetListOfLoginUsers

 

Input XML

 

<?xml version="1.0"?>

<GetListOfLoginUsers_Input>

<AdminOption>GetListOfLoginUsers</AdminOption>

                <UserName>Supervisor</UserName>

                <Password></Password>               

                <CabinetName>first</CabinetName>

</GetListOfLoginUsers_Input>

 

Output XML

 

<?xml version="1.0"?>

<GetListOfLoginUsers_Output>

                <AdminOption>GetListOfLoginUsers</AdminOption>

                <Status>0</Status>

                <Users>

                                <User>

                                                <UserIndex>1</UserIndex>

                                                <UserName>Supervisor</UserName>

                                                <UserDBId>-2123864234</UserDBId>

                                                <HostName>ruchit</HostName>

                                </User>

                                <User>

                                                <UserIndex>1</UserIndex>

                                                <UserName>Supervisor</UserName>

                                                <UserDBId>-2099016839</UserDBId>

                                                <HostName>shikhar</HostName>

                                </User>

</Users>

</GetListOfLoginUsers_Output>

 

DisconnectUsers

 

Input XML

 

<?xml version="1.0"?>

<DisconnectUsers_Input>

                <AdminOption>DisconnectUsers</AdminOption>

                <UserName>Supervisor</UserName>

                <Password></Password>               

                <CabinetName>first</CabinetName>

                <Users>

                                <User>

                                                <UserDBId>-2099016839</UserDBId>

                                                <HostName>shikhar</HostName>

                                </User>

                                <User>

                                                <UserDBId>-2000227213</UserDBId>

                                                <HostName>shikhar</HostName>

                                </User>

                </Users>

</DisconnectUsers_Input>

 

Output XML

 

<?xml version="1.0"?>

<DisconnectUsers_Output>

<AdminOption>DisconnectUsers</AdminOption>

                <Status>0</Status>

</DisconnectUsers_Output>

 

 

DeleteCabinet

 

Input XML

 

<?xml version="1.0"?>

<DeleteCabinet_Input>

                <AdminOption>DeleteCabinet</AdminOption>

                <CabinetName>first</CabinetName>           

                <IP></IP>

                <Port></Port>

                <UserName></UserName>

                <UserPassword></UserPassword>

                <DataBaseType></DataBaseType>

</DeleteCabinet_Input>

 

Output XML

 

<?xml version="1.0"?>

<DeleteCabinet _Output>

<AdminOption> DeleteCabinet</AdminOption>

                <Status>0</Status>

</DeleteCabinet _Output>

 

 

Compile

 

Input XML

 

<?xml version="1.0"?>

<Compile_Input>

<AdminOption>Compile</AdminOption>

                <CabinetInfo>

                                <CabinetName>first</CabinetName>           

                                <CabinetType>first</CabinetType>

                </CabinetInfo>

</Compile_Input>

 

Output XML

 

<?xml version="1.0"?>

< Compile_Output>

<AdminOption>Compile</AdminOption>

                <Status>0</Status>

</Compile_Output>

 

 

 

 

Storage Management Server

 

This section provides sample  Input and Output XML for Storage Management Server configuration operations.

 

 

StartServer

 

Input XML

 

<?xml version="1.0"?>

<StartServer_Input>

                <AdminOption>StartServer</AdminOption>

</StartServer_Input>

 

Output XML

 

<?xml version="1.0"?>

<StartServer_Output>

<AdminOption>StartServer</AdminOption>

                <Status>0</Status>

</StartServer_Output>

 

StopServer

 

Input XML

 

<?xml version="1.0"?>

<StopServer_Input>

                <AdminOption>StopServer</AdminOption>

</StopServer_Input>

 

Output XML

 

<?xml version="1.0"?>

<StopServer_Output>

<AdminOption>StopServer</AdminOption>

                <Status>0</Status>

</StopServer_Output>

 

 

SetServerProperty

 

Input XML

 

<?xml version="1.0"?>

<SetServerProperty_Input>

<AdminOption> SetServerProperty</AdminOption>

<ServerIni>

                <Port></Port>

</ServerIni>

<ClientList>//to be specified only if a client is to be disconnected

                                <Client>

                                                <ClientId> </ClientId>

                                <ClientIPAddress></ClientIPAddress>

                                                <Operation></Operation>//flag (‘D’) for disconnect

                </Client>

</ClientList>

<LabelList>

<Label>

<Operation></Operation>//flag ‘A’ to add, ‘R’ to remove, ‘M’ to modify

                <LabelName>< /LabelName >

                <LabelPath>< /LabelPath >//only when flag is A or M

                <CreateDirFlag></ CreateDirFlag >//only when flag is A or M

</Label>

</ LabelList >

</SetServerProperty_Input>

 

 

Output XML

 

<?xml version="1.0"?>

<SetServerProperty_Output>

<AdminOption></AdminOption>

<Status></Status>

</SetServerProperty_Output>

 

 

GetServerProperty

 

Input XML

 

<?xml version="1.0"?>

<GetServerProperty_Input>

                <AdminOption> GetServerProperty </AdminOption>

<Flag></Flag>//string //1111

</GetServerProperty_Input>

 

Output XML

 

<?xml version="1.0"?>

<GetServerProperty_Output>

<AdminOption></AdminOption>

<ServerStatus>

<Status></Status>//running/idle

                <Port></Port>

                <NoOfLabels></NoOfLabels>

                <NoOfUsers></NoOfUsers>

                <TimeSinceStarted></TimeSinceStarted>

</ServerStatus >

<ClientList>

<Client>

<Id></Id>

<Location></Location>

<ConnectedAt></ConnectedAt>

<LastRequestAt></LastRequestAt>

<Status></Status>             

</Client>

</ClientList>

<HistoryList>

<Client>

<Id></Id>

<Location></Location>

<ConnectedAt></ConnectedAt>

<DisconnectedAt></ DisconnectedAt >

< DisconnectedType></ DisconnectedType >

</Client>

                </HistoryList>

<LabelList>

<Label>

<LabelName>RECYCLED</LabelName>

<Path>c:\RECYCLED</Path>

<Created>14-Jan-02 1:15 PM</Created>

<LastAccessed>14-Jan-02 1:15 PM</LastAccessed>

<SpaceUsed>85</SpaceUsed>

</Label>

</LabelList>

</GetServerProperty_Output>

 

 

 

Thumbnail Manager

 

 This section provides sample  Input and Output XML for Thumbnail Manager configuration operations.

 

GetThumbnailMgrProperty

 

 

Input XML

 

<?xml version=1.0>

<GetThumbnailMgrProperty_Input>

<AdminOption>GetThumbnailMgrProperty</AdminOption>

</GetThumbnailMgrProperty_Input>

 

Output XML

 

<?xml version="1.0"?>

<GetThumbnailMgrProperty_Output>

<AdminOption>GetThumbnailMgrProperty</AdminOption>

<Status>0</Status>

<ThumbnailMgrInfo>

                <UI>

                                <enabled>false</enabled>

                                <debug>true</debug>

                                <batchsize>10</batchsize>

                </UI>

                <NOTIFICATION SINK>

                                <enabled>true</enabled>

                                <maxpages></maxpages>

                                <generatelog>true</generatelog>

                </NOTIFICATION SINK>

                <GENERAL>

                                <documenttype>I<documenttype>

                                <thumbnailservicehost>192</thumbnailservicehost>

                                <thumbnailserviceport>23</thumbnailserviceport>

                                <serverport>9002</serverport>

                                <maxconnections>10</maxconnections>

                </GENERAL>

                <SCHEDULER>

                                <enabled>true</enabled>

                                <generatelog>true</generatelog>

                                <sleeptime>60000</sleeptime>

                                <waittime>5000</waittime>

                                <maxthreadcount>10</maxthreadcount>

                                <noofpages>20</noofpages>

                                <cabinets>

                                                <cabinet>

                                                                <cabinetname>eworkstyle</cabinetname>

                                                                <jtsip>192.168.5.87</jtsip>

                                                                <jtsport>2222</jtsport>

                                                                <user>supervisor</user>

                                                                <password>supervisor</password>

                                                                <priority>20</priority>

                                                </cabinet>

                                </cabinets>

                </SCHEDULER>

</ThumbnailMgrInfo>

</GetThumbnailMgrProperty_Output>

 

ChangeThumbnailMgrProperty

 

Input XML         

                                        

<?xml version="1.0"?>                                      

<ChangeThumbnailMgrProperty_Input>                         

<AdminOption>ChangeAlarmMailerProperty</AdminOption>     

<ThumbnailMgrInfo>                                         

                <UI>                                                   

                                <enabled>false</enabled>                           

                                <debug>true</debug>                                

                                <batchsize>10</batchsize>                           

                </UI>                                                  

                <NOTIFICATION SINK>                                    

                                <enabled>true</enabled>                            

                                <maxpages></maxpages>                              

                                <generatelog>true</generatelog>                    

                </NOTIFICATION SINK>                                   

                <GENERAL>                                              

                                <documenttype>I<documenttype>                      

                                <thumbnailservicehost>192</thumbnailservicehost>   

                                <thumbnailserviceport>23</thumbnailserviceport>    

                                <serverport>9002</serverport>                      

                                <maxconnections>10</maxconnections>                

                </GENERAL>                                             

                <SCHEDULER>                                            

                                <enabled>true</enabled>                            

                                <generatelog>true</generatelog>                    

                                <sleeptime>60000</sleeptime>                       

                                <waittime>5000</waittime>                           

                                <maxthreadcount>10</maxthreadcount>                

                                <noofpages>20</noofpages>                          

                </SCHEDULER>                                           

</ThumbnailMgrInfo>                                        

</ChangeThumbnailMgrProperty_Input>                        

                                                           

Output XML

 

<?xml version="1.0"?>                                      

<ChangeThumbnailMgrProperty_Output>                        

<AdminOption>ChangeThumbnailMgrProperty</AdminOption>    

<Status>0</Status>                                         

</ChangeThumbnailMgrProperty_Output>                       

                                                           

                                                           

Shutdown

 

Input XML

 

<?xml version="1.0"?>

<Shutdown_Input>

                <AdminOption>Shutdown</AdminOption>

</Shutdown_Input>

 

Output XML

 

<?xml version="1.0"?>               

<Shutdown_Output>                   

                <AdminOption>Shutdown</AdminOption>

                <Status>0</Status>                  

</Shutdown_Output>                  

 

 

Restart

 

Input XML

 

<?xml version="1.0"?>             

<Restart_Input>                   

                <AdminOption>Restart</ConfigOption>

</Restart_Input>                   

 

Output XML

 

<Restart_Output>                   

                <AdminOption>Restart</AdminOption> 

</Restart_Output>   

 

AddCabinet

 

Input XML

<?xml version="1.0"?>

<AddCabinet_Input>

<AdminOption>AddCabinet</AdminOption>

<cabinet>                                       

<cabinetname>eworkstyle</cabinetname>      

                <jtsip>192.168.5.87</jtsip>                

                <jtsport>2222</jtsport>                    

                <user>supervisor</user>                    

                <password>supervisor</password>            

                <priority>20</priority>                    

</cabinet>

</AddCabinet_Input>                                     

 

Output XML

<?xml version="1.0"?>

<AddCabinet_Output>

<AdminOption>AddCabinet</AdminOption>

<Status>0</Status>

</AddCabinet_Output>

 

RemoveCabinet

 

Input XML

<?xml version="1.0"?>

<RemoveCabinet_Input>

<AdminOption>RemoveCabinet</AdminOption>

<cabinet>                                      

<cabinetname>eworkstyle</cabinetname>      

                <jtsip>192.168.5.87</jtsip>                

                <jtsport>2222</jtsport>                    

</cabinet>

</ RemoveCabinet_Input>                               

</ RemoveCabinet_Input>                                     

 

Output XML

<?xml version="1.0"?>

< RemoveCabinet _Output>

<AdminOption> RemoveCabinet </AdminOption>

<Status>0</Status>

</ RemoveCabinet_Output>