Merge branch '19981-reuse-flex-keep-cache'

[arvados.git] / doc / admin / collection-managed-properties.html.textile.liquid

diff --git a/doc/admin/collection-managed-properties.html.textile.liquid b/doc/admin/collection-managed-properties.html.textile.liquid
index c6943acaee5e647dd5f8874a09deb124be6dd997..341030c418d1e88030a36f6b7e422f760e5940f6 100644 (file)
--- a/doc/admin/collection-managed-properties.html.textile.liquid
+++ b/doc/admin/collection-managed-properties.html.textile.liquid
@@ -24,7 +24,7 @@ For every newly created collection, assign a predefined key/value pair if it isn
 <pre>
 Collections:
   ManagedProperties:
 <pre>
 Collections:
   ManagedProperties:

-    foo: {value: bar}
+    foo: {Value: bar}

 </pre>
 
 h4. Original owner UUID
 </pre>
 
 h4. Original owner UUID


@@ -34,26 +34,36 @@ This behavior will assign to a property key the UUID of the user who owns the co
 <pre>
 Collections:
   ManagedProperties:
 <pre>
 Collections:
   ManagedProperties:

-    responsible_person_uuid: {function: original_owner}
+    responsible_person_uuid: {Function: original_owner}

 </pre>
 
 h4. Protected properties
 
 </pre>
 
 h4. Protected properties
 

-If there's a need to prevent a non-admin user from modifying a specific property, even by its owner, the @protected@ attribute can be set to @true@, like so:
+If there's a need to prevent a non-admin user from modifying a specific property, even by its owner, the @Protected@ attribute can be set to @true@, like so:

 
 <pre>
 Collections:
   ManagedProperties:
 
 <pre>
 Collections:
   ManagedProperties:

-    responsible_person_uuid: {function: original_owner, protected: true}
+    sample_id: {Protected: true}

 </pre>
 
 </pre>
 

-This property can be applied to any of the defined managed properties. If missing, it's assumed as being @false@ by default.
+This configuration won't assign a @sample_id@ property on collection creation, but if the user adds it to any collection, its value is protected from that point on.
+
+Another use case would be to protect properties that were automatically assigned by the system:
+
+<pre>
+Collections:
+  ManagedProperties:
+    responsible_person_uuid: {Function: original_owner, Protected: true}
+</pre>
+
+If missing, the @Protected@ attribute it’s assumed as being @false@ by default.

 
 h3. Supporting example scripts
 
 When enabling this feature, there may be pre-existing collections that won't have the managed properties just configured. The following script examples may be helpful to sync these older collections.
 
 
 h3. Supporting example scripts
 
 When enabling this feature, there may be pre-existing collections that won't have the managed properties just configured. The following script examples may be helpful to sync these older collections.
 

-For the following examples we assume that the @responsible_person_uuid@ property is set as @{function: original_owner, protected: true}@.
+For the following examples we assume that the @responsible_person_uuid@ property is set as @{Function: original_owner, Protected: true}@.

 
 h4. List uuid/names of collections without @responsible_person_uuid@ property
 
 
 h4. List uuid/names of collections without @responsible_person_uuid@ property
 


@@ -77,7 +87,7 @@ h4. Update the @responsible_person_uuid@ property from X to Y on all collections
 
 This example can be useful to change responsibility from one user to another.
 
 
 This example can be useful to change responsibility from one user to another.
 

-Please note that the following code should run with admin privileges, assuming that the managed property is @protected@.
+Please note that the following code should run with admin privileges, assuming that the managed property is @Protected@.

 
 {% codeblock as python %}
 {% include 'admin_update_collection_property_py' %}
 
 {% codeblock as python %}
 {% include 'admin_update_collection_property_py' %}