The application's use cases

What you can do with TEXTML SDK.

Here is a summary of what your application can do with TEXTML SDK:

Table 1. Your application's use cases
High-level use case	Details
Connect to a TEXTML Server instance	Connect to an instance that you specify. Login with a user name and password. The instance can be configured to accept any user name and password. Logout and disconnect.
Manage a TEXTML Server instance	Connect (and disconnect) a TEXTML Server instance to a specific document base (docbase). Get the names of the docbases to which the server instance is connected. Get the status of an instance (Running, Stopped, Paused, etc.)
Create (install) and manage docbases	Create one or more new docbase Connect (and disconnect) a TEXTML Server instance to a specific document base (docbase). Backup, lock, unlock, update, repair, etc. a docbase.
Get the status of a docbase or a server instance
Create/manage collections	Collections are similar to folders/directories in a file system. You can: Store documents in a specified collection, and retrieve documents in a specified collection. Create, remove, copy, move, lock, unlock, and retrieve a collection. Like directories, collections are organized in hierarchies (trees). For a given collection, you can: Get its child collections. Get the name of the docbase in which the collection is contained. Get the names of the documents contained in the collection. Get its name and path.
Manage and manipulate documents	Get/set a document's name, content, MIME type, properties, custom properties, collection. Get the name of a document's docbase, server. Load a document from (or save a document to) a specified file or stream. Manage a document's content as a string or binary object.
Add/replace/manage documents in a docbase.	Add a list of documents to a docbase Replace a list of documents in a docbase with new versions of the documents. Remove a list of documents from a docbase. Lock and unlock documents, collections, and docbases
Create and modify indexes	You can create and manage indexes that are based on the contents and properties of documents in a docbase.
Search for documents	You can search for specific documents in a docbase. Usually, you search the indexes rather than perform a full-text search of the actual documents. Either way, you retrieve a document list (or document data).Then you can select which document(s) to retrieve from the docbase.
Manage the versioning of documents	Retrieve previous versions of a document. Compare to current version. Revert to a previous version Turn on or off the versioning of all documents in a docbase.