Default Workflow Actions (WorkflowInfo)
Applies to: SharePoint Foundation 2010
Actions represent the Microsoft SharePoint Foundation 2010 implementation of Windows Workflow Foundation activities. Actions are the most basic unit of work in a workflow. They define workflow activities, such as sending an email notification when an item has been added to a document library, or updating a status on a list item when a task that is associated with the item has been completed. SharePoint Foundation 2010 includes default, or predefined, workflow actions that you can use to create workflows that address common business scenarios.
Location of Default Workflow Actions
Default workflow actions are contained in the WSS.ACTIONS file, which is an XML file that lists all default conditions and actions that are available to the workflow editor. (For information about the default workflow conditions that are included in the WSS.ACTIONS file, see Default Workflow Conditions.) By default, the WSS.ACTIONS file is installed in the following location in SharePoint Foundation 2010:
%WSSRoot%\Program Files\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\1033\Workflow
Note
Direct modification of the WSS.ACTIONS file is not recommended or supported. However, you can expand the actions that are available to your code-free workflow editor by creating and adding additional custom .ACTIONS files to the same directory. SharePoint Foundation parses all files that have the .ACTIONS file name extension and creates a combined list that it then presents to the declarative, code-free workflow editor.
Default Actions
The following table lists the default workflow actions that are included with SharePoint Foundation. It also includes an example of how a rule sentence might be displayed in a code-free workflow editor. Each default action in the table also shows how to write XML to display the rule sentence.
Action |
Description |
|---|---|
Add Time To Date |
Adds a time interval to a date field. Can be specified in minutes, hours, days, months, and years. Rule sentence: Add this manyunits to date (Output to [Variable: date]) XML: Add %1 %2 to %3 (Output to %4) |
Assign a Form to a Group |
Assigns a survey form to a group of people. Values submitted by the individuals in the group are stored in the Tasks list. The workflow process remains paused until all survey forms are completed. Rule sentence: Assign a custom form to these users XML: Assign %1 to %2 |
Assign a To-do Item |
Assigns a task in the Tasks list for specified users. The workflow process remains paused until all items are completed. Rule sentence: Assign a to-do item to these users XML: Assign %1 to %2 |
Build Dynamic String |
Allows the creation of a dynamic string that is stored in a specified workflow variable. Rule sentence: Store dynamic string in Variable: variable XML: Store %1 in %2 |
Check In Item |
Performs a check-in for the specified list or document library item and allows comments to be added automatically during the execution of the workflow. Rule sentence: Check in item in this list with comment: comment XML: Check in item in %1 with comment: %2 |
Check Out Item |
Performs a check-out for the specified list or document library item. Rule sentence: Check out item in this list XML: Check out item in %1 |
Collect Data from a User |
Assigns a task to a user that includes custom form fields for data collection. Rule sentence: Collect data from this user (Output to Variable:collect) XML: Collect %1 from %2 (Output to %3) |
Copy List Item |
Instructs the workflow to copy a specified list item from one list to another. Rule sentence: Copy item in this list to this list XML: Copy item in %1 to % |
Create List Item |
Instructs the workflow to create a list item in a specified list. Rule sentence: Create item in this list (Output to Variable: create) XML: Create item in %1 (Output to %2) |
Delete Item |
Deletes a specified list item. Rule sentence: Delete item in this list XML: Delete item in %1 |
Discard Check Out Item |
Instructs the workflow to undo a check-out. If someone has the item checked out when this occurs, all changes are lost. Rule sentence: Discard check-out of item in this list XML: Discard check-out of item in %1 |
Do Calculation |
Performs a calculation of two values and stores the results in a workflow variable. Rule sentence: Calculate valueplusvalue (Output to Variable: calc) XML: Calculate %1 %2 %3 (Output to %4) |
Log to History List |
Creates an entry in the history list with a message that can be created with static text or text that is dynamically generated from a lookup control. Rule sentence: Log this message to the workflow history list XML: Log %1 to the workflow history list |
Pause For Duration |
Pauses the workflow for a specified time interval. When the interval has expired, the workflow resumes. Rule sentence: Pause for this many days, this many hours, this many minutes XML: Pause for %1 days, %2 hours, %3 minutes |
Pause Until Date |
Pauses the workflow until a specified date and time, at which point the workflow resumes. Rule sentence: Pause until this time XML: Pause until this time |
Send an Email |
Sends an email message to a specified user or group. The email message can contain To, CC, Subject, and Body fields. The Body field can contain both static text and text that is dynamically generated from a lookup table. Rule sentence: Email this message XML: Email %1 |
Set Content Approval Status |
Sets the content approval status of an item to Approved, Rejected, or Pending. This action also adds comments. Rule sentence: Set content approval status to this status with Comments: comments XML: Set content approval status to %1 with %2 |
Set Field in Current Item |
Sets a field in the current item to a specified value or lookup value. Rule sentence: Set field to value XML: Set %1 to %2 |
Set Time Portion of Date/Time Field |
Instructs the workflow to set the time to a particular value for a specified date. This information is stored in a workflow variable for later use. Rule sentence: Set time as hours:minutes for date (Output to Variable: date) XML: Set time as %1:%2 for %3 (Output to %4) |
Set Workflow Variable |
Instructs the workflow to set a value for the specified workflow variable. Rule sentence: Set workflow variable to value XML: Set %1 to %2 |
Stop Workflow |
Stops the workflow and creates an entry with a specified message in the workflow history log. Rule sentence: Stop the workflow and log this message XML: Stop the workflow and log %1 |
Update List Item |
Instructs the workflow to update a field in a list item with a specified value. Rule sentence: Update item in this list XML: Update item in %1 |
Wait For Field Change in Current Item |
Pauses the workflow until a field is updated with a specific value. Rule sentence: Wait for fieldto equalthis value XML: Wait for %1 %2 %3 |