List of Image server Functions

 

For Java Application

For Visual C++/Visual Basic Application

List of supporting Classes

List of supporting Structure

For Java Application

 

Site
Call

Usage

JPISRegisterSite

For registering a new Site with Image Server

JPISGetSitesList

 

JPISRecoverSite

To recover the Site info in the database if it is accidentally deleted

Volume

JPISCreateVolume

To create a new volume in the Image Server

JPISCreateVolume_MT

Multithreaded call to create a new volume in the Image Server

JPISCreateVolBlock

To create a new volume block for the specified volume at given site

JPISGetVolumesList

To get list of volumes in Image server

JPISAddSiteForVolReplication

To associate a site with a volume where that volume can be replicated.

JPISGetSitesForVolume

To get list of sites where the specified volume exists in Image server.

JPISGetVolumeBlocksList

To get list of Volume Blocks for the specified volume and site

JPISGetVolumeIdFromName

To get Index of volume for the specified volume name

JPISGetVolumeAttributes

To get the various attributes of volume specified

JPISChangeDefVolumePath

To Change the default volume path for a volume at some specified site

JPISRenameVolume

To rename a volume

JPISDeleteVolume

To delete the volume specified

JPISReplicateVolume

To replicate the documents belonging to a Volume on the site specified

JPISChangeVolBlockSize

To change the Volume Block size for the specified volume.

JPISMoveVolBlock

To move a volume block to some other path

JPISChangeReplicateType

To change the replicate type for a Volume.

JPISDeleteVolumeReplica

To delete the replica of a volume on a specified site

JPISDeleteVolume

To delete the specified volume.

JPISCompactVolume

To compact the specified volume.

JPISCompactVolumeBlock

To compact the specified volume block.

JPISRecoverVolBlock

To recover volume block from a PN File.

JPISGetVolumeReplicationStatus

To get the status of volume replication.

Document

JPISAddDoc

To add a document in SMS

JPISAddDocument _MT

Multithreaded call to add a document in SMS

JPISDeleteDoc

To mark a single document for deletion

JPISDeleteDocumentList

To mark a list of documents for deletion.

JPISDeleteDoc_MT

Multithreaded call to mark a single document call for deletion.

JPISGetDocInFile

To retrieve the complete document in the specified file.

JPISGetPage

To retrieve a page of the document in a buffer.

JPISGetPage_MT

Multithreaded call to retrieve a page of the document in a buffer.

JPISGetDocInFile_MT

Multithreaded call to retrieve the complete document in the Specified stream.

JPISGetDocInFile_MT

Multithreaded call to retrieve the complete document in the Specified File.

JPISReplicateDoc

To replicate a document on a specified site.

JPISSalvageDoc

To salvage a document which has been marked for deletion.

JPISSalvageDoc_MT

Multithreaded call to salvage a document which has been marked for deletion.

JPISGetDocSize

To get the size of a document.

General

JPISRegisterConnection

To connect a userUser to the specified site called as ClientSite.

JPISUnRegisterConnection

To close a connection to the ClientSite

JPISGetSMSLabels

To get the list of labels on SMS Server

JPISGetPeriodicDataReport

To get the info about the amount of data added between two dates.

JPISGetDataReport

To get the info about the amount of data added on the current date.

 

List of supporting Classes

 

1.  Class Name

JPDBInteger

     Package

Jdts.DataObject

     Description

This class is a wrapper for primitive integer type int of Java

 

Member Variable Name
Description

Type

value

value of the integer

int

errorMsg

any string associated with the integer value.

String

 

2.  Class Name

JPDBChar

     Package

Jdts.DataObject

     Description

This class is a wrapper for primitive character type char of Java.

 

Member Variable Name
Description

Type

value

value of the char

char

 

 

3.  Class Name

JPDBShort

     Package

Jdts.DataObject

     Description

This class is a wrapper for the primitive integer type short of Java.

 

Member Variable Name
Description

Type

value

value of the short

short

 

 

4.  Class Name

JPDBString

     Package

Jdts.DataObject

     Description

This class encapsulates information about a string value. This class has been defined to obtain a mutable String object.

 

Member Variable Name
Description

Type

value

value of the string

string

 

 

5.  Class Name

JtsConnection

     Package

Jdts.Client

     Description

This class encapsulates a Socket connection to the JTS.

 

Member Variable Name
Description

Type

jtsSocket

Socket connection to the JTS

Socket

jtsOut

An output stream for writing bytes to the socket.

DataOutputStream

jtsIn

An input stream for reading bytes from the socket.

DataInputStream

connectStatus

Indicates whether socket connection is valid or not.

boolean

 

 

6.  Class Name

JPISIsIndex

     Package

ISPack.ISUtil

     Description

This class encapsulates information about a document in SMS viz. the volume index in which document is present and the index of the document in that volume.

 

Member Variable Name
Description

Type

m_sVolumeId 

Index of volume in which document is present

short

m_nDocIndex  

Image Index of the document ( Index of the document in the volume)

int

 

 

7.  Class Name

JPISDocRepStat

     Package

ISPack.ISUtil

     Description

This class encapsulates information about status of replication of a document on the Replica sites.

 

Member Variable Name
Description

Type

m_sSiteId

Index of site

short

m_bDocStatus

A Boolean value indicating whether replication of document on the site specified in siteid was successful (True) or failed (False)

boolean

 

 

8.  Class Name

JPISReplicaSiteList

     Package

ISPack.ISUtil

     Description

This class encapsulates information about a site and the status of replication on the site on which the replication of a volume is done.

 

Member Variable Name
Description

Type

m_sReplicaSite

Index of site on which replication of the given volume is to be done.

short

m_strReplicaPath

Label where replication of the volume is to be done.

int

m_bReplicaStatus

Specifies the status of replication i.e. whether the replication of volume was done or not.

boolean

 

 

9.  Class Name

JPDBISSITE

     Package

Jdts.DataObject

     Description

This class encapsulates complete information about a site in which some volume was added.

 

Member Variable Name
Description

Type

m_nPortId

Port on which SMS is running.

short

m_strDefaultVolPath

The label in which the volume is present.

String

 

 

10.  Class Name

JPDBFragment

     Package

Jdts.DataObject

     Description

This class encapsulates complete information about a volume block.

 

Member Variable Name
Description

Type

m_nFragment

Index of the volume block.

short

m_nCurrentOffset

Empty space left in the volume block.

int

 

 

11.  Class Name

JPDBISReplicate

     Package

Jdts.DataObject

     Description

This class encapsulates information about the site and the number of documents replicated on it.

 

Member Variable Name
Description

Type

m_nSiteId

Index of the site.

short

m_nDocsReplicated

Number of documents replicated on the site with the given SiteId.

int

 

 

12.  Class Name

SMSVolumeInfo

     Package

NSMS

     Description

This class encapsulates information about a volume.

 

Member Variable Name
Description

Type

label

Label  in which the volume is present.

String

volumeType

Not Used

short

freeSpace

Free space available on the label.

int

 

 

For Visual C++/Visual Basic Application

 

Site
Call

Usage

NGISRegisterSite

For registering a new Site with Image Server

NGISGetSitesList

 

NGISRecoverSite

To recover the Site info in the database if it is accidentally deleted

Volume

NGISCreateVolume

To create a new volume in the Image Server

NGISCreateVolume_MT

Multithreaded call to create a new volume in the Image Server

NGISCreateVolBlock

To create a new volume block for the specified volume at given site

NGISGetVolumesList

To get list of volumes in Image server

NGISAddSiteForVolReplication

To associate a site with a volume where that volume can be replicated.

NGISGetSitesForVolume

To get list of sites where the specified volume exists in Image server.

NGISGetVolumeBlocksList

To get list of Volume Blocks for the specified volume and site

NGISGetVolumeIdFromName

To get Index of volume for the specified volume name

NGISGetVolumeAttributes

To get the various attributes of volume specified

NGISChangeDefVolumePath

To Change the default volume path for a volume at some specified site

NGISRenameVolume

To rename a volume

NGISDeleteVolume

To delete the volume specified

NGISReplicateVolume

To replicate the documents belonging to a Volume on the site specified

NGISChangeVolBlockSize

To change the Volume Block size for the specified volume.

NGISMoveVolumeBlock

To move a volume block to some other path

NGISChangeReplicateType

To change the replicate type for a Volume.

NGISDeleteVolumeReplica

To delete the replica of a volume on a specified site

NGISDeleteVolume

To delete the specified volume.

NGISCompactVolume

To compact the specified volume.

NGISCompactVolumeBlock

To compact the specified volume block.

NGISRecoverVolBlock

To recover volume block from a PN File.

NGISGetVolumeReplicationStatus

To get the status of volume replication.

Document

NGISAddDocument

To add a document in SMS

NGISAddDocument _MT

Multithreaded call to add a document in SMS

NGISDeleteDoc

To mark a single document for deletion

NGISDeleteDocumentList

To mark a list of documents for deletion.

NGISDeleteDoc_MT

Multithreaded call to mark a single document call for deletion.

NGISGetDocInFile

To retrieve the complete document in the specified file.

NGISGetPage

To retrieve a page of the document in a buffer.

NGISGetPageInFile_MT

Multithreaded call to retrieve a page of the document in a file.

NGISGetDocInFile_MT

Multithreaded call to retrieve the complete document in the Specified file.

NGISReplicateDocument

To replicate a document on a specified site.

NGISSalvageDoc

To salvage a document which has been marked for deletion.

NGISGetDocSize

To get the size of a document.

General

NGISRegisterConnection

To connect a userUser to the specified site called as ClientSite.

NGISUnRegisterConnection

To close a connection to the ClientSite

NGISGetSMSLabels

To get the list of labels on SMS Server

NGISGetPeriodicDataReport

To get the info about the amount of data added between two dates.

NGISGetDataReport

To get the info about the amount of data added on the current date.

 

 

List of supporting Structure

 

1.  Structure Name

ISINDEX

     Description

This structure encapsulates information about a document in SMS viz. the volume index in which document is present and the index of the document in that volume.

 

Member Variable Name
Description

Type

m_sVolumeId 

Index of volume in which document is present

short

m_nDocIndex  

Image Index of the document ( Index of the document in the volume)

int

 

 

2.  Structure Name

REPLICALIST

     Description

This structure encapsulates information about a site and the status of replication on the site on which the replication of a volume is done.

 

Member Variable Name
Description

Type

ReplicaSite

Index of site on which replication of the given volume is to be done.

short

ReplicaPath

Label where replication of the volume is to be done.

array of char. Maximum length is 36.

ReplicaStatus

Specifies the status of replication i.e. whether the replication of volume was done or not.

BOOL

 

 

3.  Structure Name

VOLUMELIST

     Description

This structure encapsulates complete information about a volume.

 

Member Variable Name

Description

Type

VolumeId

Index of the volume

short

HomeSite

Site index in which the volume was added.

short

VolumeName

Name of the volume.

array of char. Maximum length is 35

ReplicateType

Specifies whether the volume will be replicated instantly when documents are added or will be replicated later.

char

VolBlockSize

Size of the volume.

short

DefVolumePath

The label in which the volume is present.

array of char

Maximum length is 36

SiteName

Name of the site in which the volume was added.

array of char. Maximum length is 35

 

4.  Structure Name

GETSITESFORVOLUME

     Description

This structure encapsulates complete information about a site in which some volume was added.

 

Member Variable Name
Description

Type

SiteId

Index of the site

short

SiteAddress

IP address of SMS.

array of char. Maximum length is 20.

PortId

Port on which SMS is running.

short

DefVolumePath

The label in which the volume is present.

array of char. Maximum length is 36.

 

5.  Structure Name

BLOCKFRAGMENTLIST

     Description

This structure encapsulates complete information about a volume block.

 

Member Variable Name
Description

Type

VolBlockId

Index of the volume block.

short

VolBlockPath

Path where the PN file is added. Specified as SMS: Label\PN file name.

Array of char. Maximum length is 36.

SpaceFragmented

Empty space left in the volume block.

Int

 

 

6.  Structure Name

REPLICATESTATUS

     Description

This structure encapsulates information about the site and the number of documents replicated on it.

 

Member Variable Name
Description

Type

SiteId

Index of the site.

Short

DocsReplicated

Number of documents replicated on the site with the given SiteId.

Int

 

 

7.  Structure Name

SMSVolumeInfo

     Description

This class encapsulates information about a volume.

 

Member Variable Name
Description

Type

label

Label in which the volume is present.

Cstring

volumeType

Not Used

short

freeSpace

Free space available on the label.

DWORD