Changes between Version 44 and Version 45 of S3/S3AAA/OrgAuth

Timestamp:

09/08/12 05:11:27 (12 years ago)

Author:

Michael Howden

Comment:

--

S3/S3AAA/OrgAuth

@@ -43 +43 @@
 === Realms ===
 
-The '''realm''' of a person entity is the set of all records controlled ("owned") by this entity (="their data"). Which entity gains control over a record can be defined per record type, and even as deployment options. The realm which a particular record belongs to is encoded as person entity ID (pe_id) in the owned_by_entity field in this record.
+The '''realm''' of a person entity is the set of all records controlled ("owned") by this entity (="their data").  The realm which a particular record belongs to is encoded as person entity ID (pe_id) in the owned_by_entity field in this record. The "owned_by_entity" field - if present in the table - gets automatically populated in CRUD and Imports (during create), using the auth.s3_set_record_owner method. 
 
-The "owned_by_entity" field - if present in the table - gets automatically populated in CRUD and Imports (during create), using the auth.set_record_owner method. This method can be influenced by the '''owner_entity''' table hook:
+The entity whose realm a record will belong to will be calculate according to the following (in order of decreasing priority):
 
+==== 1. 'Global 'auth.owner_entity''' function: ====
+It is possible to set a global method for the owner_entity hook in the config.py of the respective template:
+{{{
+settings.auth.owner_entity = function
+}}}
+The global function must accept {{{(table, row)}}} as parameters, and return the pe_id (Person Entity ID) of the owner entity.
+==== 2. Table '''owner_entity''' function: ====
 {{{
 s3db.configure(tablename,
                owner_entity = function_or_lambda)
 }}}
-
-The hook function must accept {{{(table, row)}}} as parameters, and return the pe_id (Person Entity ID) of the owner entity.
-
-It is possible to set a global method for the owner_entity hook in the config.py of the respective template:
-{{{
-settings.auth.owner_entity = function
-}}}
-
-'''NOTE:''' the global owner_entity setting overrides any table-specific setting (this is deliberate), i.e. to retain a table specific setting, you must repeat it in the global hook function.
+The table function must accept {{{(table, row)}}} as parameters, and return the pe_id (Person Entity ID) of the owner entity.
+'''NOTE:''' As the global owner_entity function overrides any table-specific setting (this is deliberate), to retain a table specific setting, you must repeat it in the global owner_entity function.
+==== 4. {{{pe_id}}} field in record ====
+==== 5. {{{organisation_id}}} field in record ====
+==== 6. {{{site_id}}} field in record ====
+==== 7. {{{group_id}}} field in record ====
+==== 8. User's Organisation ====
+''Proposed''
+==== 9. User ====
+''Proposed''
+==== 10. None ====
+''Proposed to be removed''
+If none of the above apply, then the record will not belong to any realm and can be accessed by all realms
 === Role Restrictions ===