Permissions by user role

The following table lists the tasks that can be performed according to user role.

Note:
  • The Server Administrator role includes the permissions of the Server User, Document Base Administrator, and Document Base User roles.
  • The Document Base Administrator includes the permissions of the Document Base User role.
Note: No permission can be set for the ConnectServer() method.
Table 1. Permissions by user role
User role Server Admin Server User DocBase Admin DocBase User
Task Function
Assign docbase permissions SetNamesInRole X   X  
Assign server permissions SetNamesInRole X      
Back up a docbase Backup X   X  
Break lock on collections locked by another user UndoLock Collections X   X  
Break lock on documents locked by another user UndoLock Documents X   X  
Cancel backup CancelBackup X   X  
Connect to a docbase ConnectDocBase X   X X
Create a docbase CreateDocbase X      
Get docbase properties Get_Properties X   X X
Get list of docbases Get_DocbaseList X X    
Get server properties Get_Properties X X    
Get server statistics Get_Statistics X X    
Get the groups or users for a given docbase security role GetNamesInRole X   X  
Get the groups or users for a given server security role GetNamesInRole X      
Insert documents SetDocuments X   X X (except for Index Definition document)
Install a docbase InstallDocBase (new docbase)

LoadDocbase (existing docbase)

 X      
Lock a docbase LockDocBase X   X  
Lock a server LockServer X      
Lock the Index Definition document LockSystem Documents X   X  
Modify docbase properties Put_Properties X   X  
Modify server properties Put_Properties X      
Open and read documents GetDocuments X   X X
Remove specific document versions RemoveVersions X   X X (except for Index Definition document)
Remove system documents (Index Definition documents, DTDs, custom properties document, etc.) RemoveSystem Documents X   X X (except for Index Definition document)
Rename a docbase RenameDocbase X      
Search documents SearchDocuments X   X X
Search index values and result space Get_IndexedValues

Item

 X   X X
Search indexes SearchIndexes X   X X
Sort results Sort X X   X
Start docbase repair StartRepair X   X  
Start docbase update StartUpdate X   X  
Stop docbase repair StopRepair X   X  
Stop docbase update StopUpdate X   X  
Stop server Stop X   X  
Switch to another user name (internal function) SetUser X   X  
Write documents SetDocuments X   X X (except for Index Definition document)
Unload a docbase UnloadDocBase X      
Unlock a docbase LockDocBase X   X  
Unlock all collections (locked by user) UnlockAll Collections X   X  
Unlock all documents (locked by user) UnlockAll Documents X   X  
Unlock a docbase (locked by user) UnlockDocBase X   X  
Unlock system documents (locked by user) UnlockSystem Documents X   X X (except for Index Definition document)

Repository/Collection permissions per user role

The following table lists the repository/collection permissions that are assigned by default according to the user role. These permissions can be customized at the repository and collection level.

Table 2. Repository/Collection permissions
User role Server Admin Server User DocBase Admin DocBase User
Permission
Read X X X X
Write X X X X
User Administration X   X