matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation updates, split indexes and permissions into sections

Browse Source
This commit is contained in:
Roberto Rosario
2012-02-11 21:21:16 -04:00
parent f94f997883
commit d1621c6120
2 changed files with 35 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/topics/indexes.rst
View File

@@ -3,6 +3,10 @@ Indexes
======= =======
Indexes are an automatic method to hierarchically organize documents in relation to their metadata and to each other. Indexes are an automatic method to hierarchically organize documents in relation to their metadata and to each other.
Index templates
===============
Since multiple indexes can be defined, the first step is to create an empty index. Since multiple indexes can be defined, the first step is to create an empty index.
Administrators then define the tree template showing how the index will be structured. Administrators then define the tree template showing how the index will be structured.
Each branch can be a pseudo folder, which can hold other child 'folders' or Each branch can be a pseudo folder, which can hold other child 'folders' or
@@ -12,13 +16,19 @@ matched the path to reach the document container.
.. image:: index_template.png .. image:: index_template.png
:alt: index template :alt: index template
This template is the skeleton from which an instance of the index is then Index instances
===============
The template is the skeleton from which an instance of the index is then
auto-populated with links to the documents depending on the rules of each auto-populated with links to the documents depending on the rules of each
branch of the index evaluated against the metadata and properties of the documents. branch of the index evaluated against the metadata and properties of the documents.
.. image:: index_instance.png .. image:: index_instance.png
:alt: index instance :alt: index instance
Index serving
=============
Indexes can be mirrored to the operating system filesystem Indexes can be mirrored to the operating system filesystem
using the configuration option using the configuration option
:setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING`. :setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING`.

41
docs/topics/permissions.rst
View File

@@ -5,26 +5,33 @@ Permissions
**Mayan EDMS** provides very exact control over what activies users can **Mayan EDMS** provides very exact control over what activies users can
perform. This control is divided into two levels of operation: perform. This control is divided into two levels of operation:
* 2-tier permission assignment - This level of activity control works 2 tier permissions assignement
by allowing roles that are composed of users and group, to be granted ==============================
a permission such that the holder of that permission can exercise it
throught the entire collection of objects (document, folders, tags, etc),
this method could be thought out as a global permission granting level.
Example: Roles being granted the ``Document view`` permission will be able to view
**all** documents in existance.
.. image:: permissions.png This level of activity control works
:alt: 2-tier permission diagram by allowing roles that are composed of users and group, to be granted
a permission such that the holder of that permission can exercise it
throught the entire collection of objects (document, folders, tags, etc),
this method could be thought out as a global permission granting level.
Example: Roles being granted the ``Document view`` permission will be able to view
**all** documents in existance.
* 3-tier access control - When more control is desired over which objects .. image:: permissions.png
actors(user, groups and roles) can exercise an action this method should be :alt: 2-tier permission diagram
used. Under this level, actors are granted a
permission but only in relation to a selected object. Example: Granting user
``Joe`` the ``Document view`` access control for document ``Payroll``,
would allow him to view this document only.
.. image:: ACL.png
:alt: 3-tier access control diagram 3 tier access control
=====================
When more control is desired over which objects
actors(user, groups and roles) can exercise an action this method should be
used. Under this level, actors are granted a
permission but only in relation to a selected object. Example: Granting user
``Joe`` the ``Document view`` access control for document ``Payroll``,
would allow him to view this document only.
.. image:: ACL.png
:alt: 3-tier access control diagram
The permission system enforces inheritance by first checking if the user The permission system enforces inheritance by first checking if the user
has a global permission, is a member of a group or a role that has a global has a global permission, is a member of a group or a role that has a global