Changes between Version 50 and Version 51 of S3/S3AAA/OrgAuth

Timestamp:

09/13/12 21:47:49 (12 years ago)

Author:

Dominic König

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").  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 '''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 {{{realm_entity}}} field in this record. The "realm_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 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:
+==== 1. 'Global 'auth.realm_entity''' function: ====
+It is possible to set a global method for the realm_entity hook in the config.py of the respective template:
 {{{
-settings.auth.owner_entity = function
+settings.auth.realm_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: ====
+The global function must accept {{{(table, row)}}} as parameters, and return the pe_id (Person Entity ID) of the realm entity.
+==== 2. Table '''realm_entity''' function: ====
 {{{
 s3db.configure(tablename,
-               owner_entity = function_or_lambda)
+               realm_entity = function_or_lambda)
 }}}
-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.
+The table function must accept {{{(table, row)}}} as parameters, and return the pe_id (Person Entity ID) of the realm entity.
+'''NOTE:''' As the global realm_entity function overrides any table-specific setting (this is deliberate), to retain a table specific setting, you must repeat it in the global realm_entity function.
 ==== 4. {{{pe_id}}} field in record ====
 
@@ -83 +83 @@
 [[Image(orgauth2.png)]]
 
-In this list there is also an entry for '''All Entities''' which means that this role assignment is ''not'' restricted to a realm, but applies ''site-wide'' (=for all records regardless of their respective owner entity).
+In this list there is also an entry for '''All Entities''' which means that this role assignment is ''not'' restricted to a realm, but applies ''site-wide'' (=for all records regardless of their respective realm entity).
 
 The entry '''Default Realm''' means all entities the user is (or will be) an organisation unit of at the time of the request authorization.
@@ -95 +95 @@
 }}}
 
-This can either be a list of the PE IDs (=this role applies for all records where ''owned_by_entity'' belongs to this list) or None (=this role applies site-wide).
+This can either be a list of the PE IDs (=this role applies for all records where ''realm_entity'' belongs to this list) or None (=this role applies site-wide).
 === Realm Hierarchy ===