Difference between revisions of "Workflow Task Type: Update Custom Field Value"

From SmartWiki
Jump to: navigation, search
m
Line 1: Line 1:
The '''Update Custom Field Value''' workflow task type can be used to write values to custom fields on the object against which the Workflow is triggered.
+
#REDIRECT [[Workflows_Overview#Task_Type:_Update_Custom_Field_Value]]
 
 
These values can be hard-coded values, or can also use [[variables]].
 
 
 
You can also use MySQL syntax to manipulate values using [[sscalculation]].
 
 
 
 
 
[[Image:UpdateCustomFieldValue.png|link=]]
 
 
 
==Task Settings==
 
Update Custom Field Value Tasks have the following settings:
 
* '''Name''' - Narrative name for the task.
 
* '''Task Number''' - A system generated number that determines the presentation order of the task in the workflow.  This number can be changed to display the step in a different location.
 
* '''Description''' - Detailed description of the task ''(optional)''.
 
* '''Expire After''' - Intended duration of the workflow.
 
* '''Use Field''' - lists custom fields across all UTAs from the selected UTA level. This workflow task will update the selected field with the value in the "Update To Value" setting.
 
'''Note:''' It is important the field to be updated does not have the Read Only option checked in the Formatting section of the field options (or a "readonly" HTML tag or "textreadonly" CSS class).
 
* '''Update To Value''' - accepts hard-coded values and variables. This workflow task will use this value to update the field selected in the "Use Field" setting.
 
 
 
==Examples==
 
Variables can be used in the "Update To Value" setting. Some examples are as follows:
 
 
 
To populate the current date (for example, a workflow triggered at status '''Submitted''' could be configured to put today's date into a custom field called '''Date Submitted'''):
 
* '''@date(currentdate)@'''
 
 
 
To populate a date one year from the current date (for example, for a progress report that is due one year after the application is submitted):
 
* '''<!--@sscalculation(date_add(CURDATE(), INTERVAL 1 YEAR))-->'''
 
 
 
To populate with a [[System Variables|system variable]] value (for example, to put a submission deadline into a custom field when a record is created):
 
* '''@system.Submission Deadline@'''
 
 
 
==See Also==
 
* [[Variable List]]
 
* [[Update Standard Field Value]]
 
* [[Workflow Task Types]]
 
 
 
[[Category:Workflows]]
 

Revision as of 13:29, 20 July 2017