Changeset 1524 for trunk/LATMOS-Accounts/man/man8/latmos-accounts-base-sql.pod

Timestamp:

12/22/15 17:36:36 (9 years ago)

Author:

nanardon

Message:

Allow fine control on ro attributes

This patch allow to control why the status attributes become read-only when
using employment.

File:

• trunk/LATMOS-Accounts/man/man8/latmos-accounts-base-sql.pod (modified) (3 diffs)

trunk/LATMOS-Accounts/man/man8/latmos-accounts-base-sql.pod

@@ -57 +57 @@
 attributes (C<accountExpires> for Active Directory).
 
-=head2 User endEmployment
+=head2 User Employment
+
+The employment object allow you to set time when you're user have a status. This
+allow through 'Employment' module for la-sync-manager to automate changes.
+
+The synchronized attributes are:
+
+=over 4
+
+=item C<company>
+
+=item C<department>
+
+=item C<contratType>
+
+=item C<managerContact>
+
+=item C<expire>
+
+=item C<endcircuit>
+
+=back
+
+To avoid error when modifying user direclty when you're using employment those
+attribute become on user's side become read-only once an employment exists.
+
+You can change this beaviour using C<employment_lock_user> parameter:
+
+=over 4
+
+=item any (default)
+
+Any existing employment lock those attribute, you must
+create another employment to change user status or delete all employements for
+this user.
+
+=item always
+
+The user's attribute are always locked
+
+=item never
+
+The user's attribute are always locked
+
+=item active
+
+Thoses attributes are locked is any employment are still active (ie unfinished
+or coming later).
+
+=item attribute=value
+
+Thoses attributes are read-only if the C<attribute> given contains C<value>,
+C<*> allow to match any value.
+
+=head3 User endEmployment
 
 This attribute compute the next day the user will leave the company according
@@ -65 +119 @@
 exists between two employment.
 
-=head2 User endStrictEmployment
+=head3 User endStrictEmployment
 
 This attribute compute the next day the user will leave the company according
@@ -75 +129 @@
 database parameter is returned.
 
-=head2 User endLastEmployment
+=head3 User endLastEmployment
 
 This attribute return the very last end of all registered employment fr this
 user.
 
-=head2 User endCurrentEmployment
+=head3 User endCurrentEmployment
 
 The end of the employment matching current date.