Datastore Developers Guide DataStore Remote Administration Schemes

Back to > Overview > Developers Guide

DataStore Remote Administration Schemes

1. Introduction

To administer the database with remote control, DataStore use some special XML blocks ( otherwise modified SEP store and fetch command ) in each administer program. There is the list of programs:

• smchmod - change the user acces rights for documents and subtrees
• smchown - change the document owner
• smgroup - administer the user groups
• smtree - administer the subtrees where you can store documents
• smuser - administer the users

2. smchmod - Change acces permissions for subtrees and documents

The parameters is:

• recursive - (true/false) if true modify permissions recursivelly
• verbose - (true/false) if true send the results in verbose mode
• mode - the permission mode
• doc - the target document

<store action='update'><block name='_admin.trees.mode'>
   <chmod recursive=recursive  verbose=verbose>
      <mode>mode</mode>
      <doc>doc</doc>
   </chmod>
</block></store>
        

3. smchown - Change owner

The parameters is:

• recursive - (true/false) if true modify permissions recursivelly
• verbose - (true/false) if true send the results in verbose mode
• owner - the owner of document
• doc - the target document

<store action='update'><block name='_admin.trees.owner'>
   <chown recursive=recursive  verbose=verbose>
      <owner>owner</owner>
      <doc>doc</doc>
   </chown>
</block></store>
      

4. smgroup - Administer user groups

4.1. Add group

The parameters is:

• gname - the new group name

<store action='write'><block name='_admin.groups'>
   <group action='add'>
      <name>gname</name>
   </group>
</block></store>
      

4.2. Modify group

The parameters is:

• gname - the existent group name
• ngname - the new group name

<store action='update'><block name='_admin.groups'>
   <group action='mod'>
      <name>gname</name>
      <newname>ngname</newname>
   </group>
</block></store>
      

4.3. Delete group

The parameters is:

• gname - the group name which you want to delete

<store action='delete'><block name='_admin.groups'>
   <group action='del'>
      <name>gname</name>
   </group>
</block></store>
      

4.4. List group

The parameters is:

• uname - the user name from group
• gname - the group name

<fetch><union><intersect>
    <compare subtree='_admin.groups.user.uname[.group.gname]'>
    <path/><value></value></compare>
</intersect></union></fetch>
      

5. smtree - Manipulate trees in database

5.1. Create subtree

The parameters is:

• subtree - the new subtree name

<store action='write'><block name='_admin.trees'>
   <tree action='create'>
      <subtree>subtree</subtree>
   </tree>
</block></store>
      

5.2. Remove subtree

The parameters is:

• force - (true/false) if true force the delete command
• subtree - the target subtree name

<store action='delete'><block name='_admin.trees'>
   <tree action='delete' force=force>
      <subtree>subtree</subtree>
   </tree>
</block></store>
      

5.3. List subtree

The parameters is:

• isLong - (true/false) if true the result will send long (username, group, ...)
• tree - the tree name
• subtree - the subtree name

<store action='update'><block name='_admin.trees'>
   <tree action='list' long=isLong tree=tree>
      <subtree>subtree</subtree>
   </tree>
</block></store>
      

5.4. Copy subtree

The parameters is:

• recursive - (true/false) if true copy subtrees recursivelly
• verbose - (true/false) if true send the results in verbose mode
• src - the subtree which will be copied
• doc - the target subtree name

<store action='copy'><block name='_admin.trees'>
   <tree action='copy' recursive=recursive verbose=verbose>
      <src>src</src>
      <dest>dest</dest>
   </tree>
</block></store>
      

5.5. Move subtree

The parameters is:

• verbose - (true/false) if true send the results in verbose mode
• src - the subtree which will be moved
• doc - the target subtree name

<store action='write'><block name='_admin.trees'>
   <tree action='move' verbose=verbose>
      <src>src</src>
      <dest>dest</dest>
   </tree>
</block></store>
      

5.6. Change subtree store mode

The parameters is:

• recursive - (true/false) if true change recursivelly
• verbose - (true/false) if true send the results in verbose mode
• subtree - the subtree which mode will be changed
• mode - (strict/flexible/free/free_tag) the store mode

<store action='write'><block name='_admin.trees'>
   <tree action='chtype' recursive=recursive verbose=verbose>
      <subtree>subtree</subtree>
      <src>mode</src>
   </tree>
</block></store>
      

5.7. Set subtree naming flag

The parameters is:

• recursive - (true/false) if true change recursivelly
• verbose - (true/false) if true send the results in verbose mode
• subtree - the subtree which namig flag will be changed
• naming - (auto/manual) the naming flag

<store action='write'><block name='_admin.trees'>
   <tree action='naming' recursive=recursive verbose=verbose>
      <subtree>subtree</subtree>
      <src>naming</src>
   </tree>
</block></store>
      

6. smuser - Manipulate users for datastore

6.1. Add user

The parameters is:

• uname - the new user name
• upwd - the new user's password
• home - the user's home directory
• group - the user's group name

<store action='write'><block name='_admin.users'>
   <user action='add'>
      <username>uname</username>
      <password>upwd</password>
      <homedir>home</homedir>
      <group>group</group>
      <groups>
          <group name=group/>
          ...
      </groups>
   </user>
</block></store>
      

6.2. Modify user

The parameters is:

• uname - the new user name
• upwd - the new user's password
• home - the user's home directory
• group - the user's group name

<store action='update'><block name='_admin.users'>
   <user action='mod'>
      <username>uname</username>
      <password>upwd</password>
      <homedir>home</homedir>
      <group>group</group>
      <groups>
          <group name=group/>
          ...
      </groups>
   </user>
</block></store>
      

6.3. Delete user

The parameters is:

• uname - the user name

<store action='delete'><block name='_admin.users'>
   <user action='del'>
      <username>uname</username>
   </user>
</block></store>
      

6.4. List users

The parameters is:

• uname - the user name

<fetch><union><intersect>
    <compare subtree='_admin.users.uname'>
    <path/><value></value></compare>
</intersect></union></fetch>
      

6.5. Block user

The parameters is:

• uname - the user name

<store action='update'><block name='_admin.users'>
   <user action='block'>
      <username>uname</username>
   </user>
</block></store>
      

6.6. Unblock user

The parameters is:

• uname - the user name

<store action='update'><block name='_admin.users'>
   <user action='unblock'>
      <username>uname</username>
   </user>
</block></store>