All the details for the workflow control category.
Reset all of the actions on the activity. A bit like the 'Do Over' button.
The Activate Actions
activity is like a clear history
button for the current activity. When this action is run, all actions for
the current activity are set back to Uncomplete.
So next time this activity is processed, all actions will be run again.
The current processing will continue however, so further actions will
execute and possibly be completed. Normal use of this action would be to
place it at the end of your activity.
If you have the "Action is Completed on Success" option checked in your 'Activate Actions' action, then the Action will only trigger once.
It does not "uncomplete' itself, only the other actions in the activity. So, the Activity will run through exactly twice. To have the
Activity endlessly repeat, make sure this option is not checked on the Activate Actions action.
If you make changes to an Activity that is implementing the Activate Actions action (add or remove other Actions, for example), those
changes will not be reflected in existing Activity instances. Only instances of the Activity actually created after the changes are
made will see those changes.
When using this action as part of a looping Activity (Daily Loop with a Delay Action at the start, for example), if you don't blank the
'Delay Activated' Attribute value, the Delay will be essentially skipped. This is because the DateTime value in the attribute will be
in the past after the first time through. The Delay Action only sets the value of the 'Delay Activated' Activity Attribute if it is
blank when the Delay Action processes. Otherwise, the Delay Action just checks the value to see if it should continue delaying or
proceed through the Activity. So, you need to blank the 'Delay Activated' Attribute value so it is reset each time through. This is
true for any other attribute values that need to be at a known/defined starting state for the Activity.
Also know that the Delay Action will not fire until the next workflow processing window. So, for each time through the Activity
after the first time, the "real" delay time will be: Remainder Of Workflow Processing Window + Delay Action Value.
Example: If your workflows are processed every 10 minutes and you have a Delay Action set for 30 minutes, your non-first times
through your Activity will have a 'real' delay to around 40 minutes.
Starts up a new workflow activity.
This action will launch (aka activate) a new activity of the type that you
choose. This action is used heavily to control the branching logic of the
workflow. The use of action filters is very powerful with this action.
Starts an activity in another workflow
Activates an activity in all workflows where an attribute matches
Starts up a new workflow with any attribute values your new workflow needs.
Assigns the activity based on a workflow attribute.
Activities can be assigned to a person or group to help distinguish who is
responsible for ensuring that the activity is completed if there are manual steps to complete. This action will set the assignee
of the current activity to the value of a workflow attribute.
Three different actions to assign responsibility for an activity.
These three actions do very similar things, so we'll group them together. Like
the previous action, they set the assignee of an activity based on a
provided person, group or security role. It’s best to avoid assigning
actions to a specific person because you'll need to maintain this
assignment as individuals transition into new roles.
Hit the brakes! This activity is done.
This action is pretty obvious. It marks the current activity as complete.
The activity will not execute any more actions.
STOP... hammer time! Delays successful execution of action until the specified value is reached.
Temporarily pauses execution of the current activity until the set value is reached. The three value options are:
Provides a document to be electronically signed.
This action will present a person with a document that they need to sign electronically.
The Signature Document Template must be configured in advance under
Admin Tools > General Settings > Signature Documents.
Person attributes can be used to define the person the document applies to, the person
assigned to sign the document and the person who signed the document.
After the electronic signature is captured the person is asked to provide an email
address so they can be sent a copy of the document for their records.
Collects information from an individual.
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
Sets the workflow initiator from a workflow attribute.
This workflow action is the reverse of Set Attribute to Initiator.
It allows you to change the Initiator to the value of an attribute.
Because things don't always go as planned.
Logs an error into the worflow's error log.
Redirects the user to a given URL when the workflow action is complete.
This action takes the user to a different screen after the workflow action is complete.
You can set the action to redirect to either a URL or a URL Attribute.
The Processing Options
field allows you to set how the workflow should continue:
Adds a new note to the workflow.
This action will add a new workflow note. The note property has the ability to
customize the message using Lava. You can also customize the formatting of the
note by selecting the
More on using workflow notes is discussed in the
section of the workflow guide.
Our work here is complete. Or, at least the workflow is.
This is the Game Over
action that marks the entire workflow as complete. No other activities or
actions will be processed.
Workflow...? What workflow?
Simply put, deletes the current workflow instance.
Shows HTML in the WorkflowEntry block.
This action allows you to display a large amount of information in the
WorkflowEntry block, typically on the screen that appears after a person
completes and submits a Form action. The HTML field takes either HTML or
Lava, which means you have a lot of control over the formatting and
display of the content.
Save your workflow.
See the section on
persistent vs. non-persistent workflows
to get a deeper understanding of this topic. This action marks the current
workflow as persistent.
There is an optional parameter called Persist Immediately.
Normally this action will cause the workflow to be persisted (saved) once all the current activities/actions
have completed processing. Set this flag to true if the workflow should be persisted immediately. This is only
required if a subsequent action needs a persisted workflow with a valid id.
Sets the Campus of the workflow.
This action will set the campus of the workflow using the given Campus attribute or the primary campus of the given Person attribute. If both are given, the Campus attribute will be used. If neither are given, the action will return an error.
Sets the name of the workflow.
This action will set the name of the workflow. This name will appear in
the various workflow lists you use to manage and process your workflows.
The text field of this action can use Lava merge fields to help you
craft effective names. Many times these names will simply come from an
attribute value that is entered through a user entry form.
Sets the status of the workflow.
This action sets the status of the workflow. The workflow status is simply
a text field so you can set it to any value you choose. This field
supports the use of Lava merge fields.
Sets the status of another workflow.
This action allows you to set the status of a different workflow.
The workflow status is simply a text field so you can set it to any
value you choose. This field supports the use of Lava merge fields.
You can also query for the status using SQL commands. The "Process
Target Workflow" option allows you to decide whether or not to run
the targeted workflow after its status is set.
Writes a message to the Workflow log.
Every workflow has a log. Usually there's not much in them. But sometimes,
it's useful for you to be able to write what's happening or what the value
of an attribute is at a certain point in the workflow. Use this action to
write an entry in the workflow's log. It supports Lava, of course!