Therefore Programming Interface 3.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

TheServer

TheServer controls and manages all queries and transactions to and from the Therefore™ server and the database.

Namespace: Therefore.API

Name	Description
ClaimWorkflowInstance	Claims the workflow instance with the specified instance and token number.
Connect	Overloaded. Connects the current or a specified user to the Therefore™ Server.
ConnectToken	Connects to the Therefore™ Server using the specified user token.
ConvertDocNo2StgFileID	Converts a Therefore™ Document and Version Number to an ADOS Document Number (now called Storage File ID).
ConvertStgFileID2DocNo	Converts an ADOS Document Number (now called Storage File ID) to a Therefore™ Document and Version Number.
ClearCacheInfo	Clears the server cache for the specified object.
DeleteCase	Deletes the Therefore™ case with the specified case number.
DeleteDoc	Deletes the Therefore™ document with the specified document number.
DeleteTask	Deletes the Therefore™ task with the specified task number.
Disconnect	Overloaded. Disconnects the user from the server.
EraseObjects	Erases deleted documents and cases from the system.
FillDependentFields	Fills the dependent field in the TheIndexData of the TheDocument object passed to function.
GetCategories	Gets a list of categories.
GetConnectedUser	Gets a representation of the currently connected user.
GetCultureInfo	Gets a copy of the currently used culture info.
GetDefaultDomain	Gets the name of the default domain.
GetDomainNames	Gets a list of all valid domain names from the server.
GetKeywords	Gets a list of valid keywords for the TheIndexData of the specified TheDocument.
GetLatestVersionNo	Gets the version number of the specified Therefore™ document.
GetLicenseInfo	Gets license information for the connected Therefore™ server.
GetLinkedWorkflowsForDoc	Gets a list of workflow instances a document is linked to.
GetObjects	Gets a list of specified object from the server.
GetObjectRightsEx	Gets the permissions of a specified object.
GetMFP Device	This method is intended for internal use within Therefore™ only.
GetSPProfiles	This method is intended for internal use within Therefore™ only.
GetSettingInt	This method is intended for internal use within Therefore™ only.
GetSettingString	This method is intended for internal use within Therefore™ only.
GetThumbnail	Retrieves the thumbnail of a document.
GetTreeViews	Get a list of tree view items considering the specified permissions.
GetUserList	Overloaded. Gets a list of users and/or user groups in Therefore™ and/or the Windows Active Directory.
GetVersion	Gets the current Therefore™ major version, minor version and build number.
HasPermission	Checks if a user has specific permissions.
RestoreDeletedObject	Restores a document or case from the recycle bin.
SaveMFPDevice	This method is intended for internal use within Therefore™ only.
SetCultureInfo	Sets the culture info to be used. Can only be set when not being connected.
SetLanguage	Sets the connection default language. Can only be set when not being connected.
SetTenant	In a multi-tenant environment this specifies the tenant to connect to. If this is not set, then the default tenant is used.
ShowCategorySelectionDialog	Shows the category selection dialog.
ShowUserSelectionDialog	Shows the user selection dialog.
StartNewWorkflow	Starts a new workflow on a Therefore™ document in the specified workflow process.
ValidateKeywords	Validates keywords for a specified index data field.

Name	Description
Connected	Returns whether or not the TheServer object is connected to the Therefore™ server.
LastErrorCode	Returns the error code from the last server call from the TheServer object.