Workflow Action - Workflow Control - Form
Action:
Form
Category:
Workflow Control
Version:
v1.0
Content:
The Form
action is one of the most powerful actions in Rock. It allows you to take
input from a user and place it into the values of workflow attributes. Let's
dive down into the details of this incredible action looking at each
setting.
-
Notification Email: This sends a selectable
System Email Template out to the activity's assignee(s) when the
action is reached during processing. This helps alert them that an
entry step is waiting for them. This email can include links to
the commands that are defined for the action. For instance, if one
of the entry commands is Approve,
you could include the approve link in your email so that the
person could skip the step of visiting the form.
-
Enable Note Entry: Enabling this will provide an area
where the person can write notes in addition to the rest of the
form. This is a great way for people to communicate with the next
person in the process, or to track information that may not be
stored as attributes.
-
Enable Person Entry: Checking this box will
cause the “Person Entry Configuration” section to appear within the
Form configuration. Rather than manually creating individual workflow
attributes for things like the person’s name, email, phone number or
address, you can select what you want to ask and it will be added to
the form for you automatically. You also have the option of asking for
Spouse information. If the person or their spouse isn’t in Rock then
this action will create a record for them. You can set the
Person Attribute,
Spouse Attribute and
Family Attribute
fields to store this information for either newly created or existing
records, for use later in the workflow. On top of that, you can also
enable
Hide if Current Person Known
to hide all the person entry fields if Rock already knows
who the person is. Note, the fields will still show on the form if one
of them is required and if that piece of information is not in Rock for
the person.
-
Form Header: This is a textbox that allows you to
enter HTML combined with lava merge fields. This is a good place
to add instructions for the user and help introduce them to the
form they are about to complete.
-
Form Fields: Next you'll see a list of all the
workflow and activity attributes available. You can select which
are visible, editable and required for the entry form. You can
apply conditional logic to each field so that it only appears to
the person if they give certain responses on other fields.
-
Form Footer: Like the header, the footer allows
you to enter HTML mixed with lava merge fields to help provide
any closing content you would like.
-
Commands: Finally, you have a list of commands to
display at the end of your form. Each of the commands will be
displayed as a button at the bottom of your form. The
Command Label
will be the label on the button. The Button Type
describes what button style to use (these are defined under
Admin Tools > General Settings > Defined Types > HTML Button Styles.)
Next you can define an activity to run when the button is selected.
This is very helpful for providing branching logic in your workflow.
Finally, you can provide response text that the user will see when
the action has been selected. Note that if a secondary form is
available after the current form, this response text may not be
shown. Instead the user will be taken directly to the second form.
-
Command Selected Attribute: This optional setting allows you
to insert the command label that was selected into the contents of an
attribute. This is helpful when you're not activating activities
from the actions.