14018: Add ProcessProperties to documentation
authorPeter Amstutz <peter.amstutz@curii.com>
Tue, 7 Sep 2021 18:59:11 +0000 (14:59 -0400)
committerPeter Amstutz <peter.amstutz@curii.com>
Tue, 7 Sep 2021 18:59:11 +0000 (14:59 -0400)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

doc/user/cwl/cwl-extensions.html.textile.liquid

index 206b75d58f20695c34f322236ee249ee5f3fefab..6a70454b10860b3cc0f41aeac03661a5c3f0c140 100644 (file)
@@ -52,6 +52,11 @@ hints:
   arv:OutputStorageClass:
     intermediateStorageClass: fast_storage
     finalStorageClass: robust_storage
+
+  arv:ProcessProperties:
+    processProperties:
+      property1: value1
+      property2: $(inputs.value2)
 {% endcodeblock %}
 
 h2(#RunInSingleContainer). arv:RunInSingleContainer
@@ -134,6 +139,14 @@ table(table table-bordered table-condensed).
 |intermediateStorageClass|string or array of strings|The storage class for output of intermediate steps.  For example, faster "hot" storage.|
 |finalStorageClass_uuid|string or array of strings|The storage class for the final output.  |
 
+h2(#ProcessProperties). arv:ProcessProperties
+
+Specify extra "properties":{{site.baseurl}}/api/methods.html#subpropertyfilters that will be set on container requests created by the workflow.  May be set on a Workflow or a CommandLineTool.  Setting custom properties on a container request simplifies queries to find the workflow run later on.
+
+table(table table-bordered table-condensed).
+|_. Field |_. Type |_. Description |
+|processProperties|key-value map, or list of objects with the fields {propertyName, propertyValue}|The properties that will be set on the container request.  May include expressions that reference `$(inputs)` of the current workflow or tool.|
+
 h2. arv:dockerCollectionPDH
 
 This is an optional extension field appearing on the standard @DockerRequirement@.  It specifies the portable data hash of the Arvados collection containing the Docker image.  If present, it takes precedence over @dockerPull@ or @dockerImageId@.