| Action |
Description |
| Core Actions |
Lists the most commonly-used actions in a workflow. |
| Add a comment |
This action is initially displayed in a workflow step as Comment: comment text. Use this action to leave informative comments in the workflow designer for reference purposes. This is especially helpful when there are other users co-authoring the workflow. For example, if a variable in the current workflow doesn't have a user-friendly name, you use this action to add a comment to indicate what the variable does in the workflow.
Following is an example of what the action might look like in a workflow step,
Comment: This variable provides the department for the workflows initiator.
Note Anyone editing the workflow in Microsoft Visio 2010 will also be able to view the comments.
|
| Add Time to Date |
This action is initially displayed in a workflow step as Add 0 minutes to date (Output to Variable:date). Use this action to add a specific time in minutes, hours, days, months, or years to a date, and stores the output value in as a variable. The date can be a current date, specific date, or a lookup.
Following is an example of what the action might look like in a workflow step,
Add 7 days to Current Item:Modified (Output to: Variable: A week from Modified)
|
| Do Calculation |
This action is initially displayed in a workflow step as Calculate value plus value (output to Variable: calc). Use this action to perform a calculation, such as add, subtract, multiply, or divide two values, and stores the output value in a variable.
Following are examples of what the action might look like in a workflow step,
- Calculate 36 divided by 9 (Output to Variable:Number of Widgets)
Calculate [fx :: Courses*, Filled Seats] plus 1 (Output to Variable: New Filled Seats)
|
| Log to History List |
Use this action to log a message about the workflow into its History list. A message can be a summary of a workflow event, or anything significant about the workflow. The workflow history list can be helpful in troubleshooting issues with the workflow.
This action is initially displayed in a workflow step as Log this message to the workflows history list. Use this action to record what a workflow has performed at a particular instance in its lifecycle. For example, you can log a message saying Copied to list A, or Sent email to reviewers. When the workflow completes successfully, you can go to the workflow's Workflow History list and see the messages display in the Description column.
Following is an example of what the action might look like in a workflow step,
Log A week from Modified variable set to the workflow history list
Note If you want an action that stops the workflow and then logs a message to the History list, use the Stop Workflow action instead.
|
| Pause for Duration |
This action is initially displayed in a workflow step as Pause for 0 days, 0 hours, 5 minutes. Use this action to pause the workflow for a specific duration in days, hours, or minutes.
Note The delay time is effected by the timer job interval, which has a default value of five minutes.
|
| Pause until Date |
This action is initially displayed in a workflow step as Pause until this time. Use this action to pause the workflow until a particular date. You can add a current date, a specific date, or a lookup.
Following are examples of what the action might look like in a workflow step,
- Pause until 1/1/2010 12:00:00 AM
Pause until Variable: A week from Modified
|
| Send an Email |
This action is initially displayed in a workflow step as Email these users. Use this action to send an email to a user or a group. It is commonly used to send a confirmation e-mail to workflow participants. Email recipients can be a user or group within the site collection or anyone inside your organization. You can now easily specify a dynamic value in your subject such as a lookup or a string.
Important Outgoing e-mail must be configured in SharePoint Central Administration.
Following is an example of what the action might look like in a workflow step,
Email Variable: approvers
|
| Set Time Portion of Date/Time Field |
This action is initially displayed in a workflow step as Set time as 00:00 for date (Output to Variable: date). Use this action to create a timestamp, and stores the output value in a variable. You can set the time in hours and minutes and add a current date, specific date or a lookup. For example, suppose you want to add a timestamp to any new customer orders that is added to an orders list. Instead of using the current time of the order received in the timestamp, you want to add a specific time so that you can have your workflow perform any action to all the new items with the same timestamp, such as routing orders to the warehouse. Another example, suppose you have a presentation at 9 a.m. on a particular day, and would like an email reminder. You can use this action to add the time to the date, pause the workflow till the day before the presentation and then have the workflow send you a reminder.
Following is an example of what the action might look like in a workflow step,
Set time as 00:00 for Current Item:Modified (Output to Modified time variable set to midnight)
|
| Set Workflow Status |
This action is initially displayed in a workflow step as Set workflow status to Canceled. Use this action to set the status of the workflow. The default options are Canceled, Approved, and Rejected.
You can enter a new status value in the dropdown in the action. Once you enter a status value, the entry is automatically added to the dropdown list. For example, you can enter a status that is more user-friendly and informative than Completed or Canceled, such as Expense Report Approved.
Notes
- You cannot rename or delete a status value once it has been created. However, you do not have to use it.
- A custom status is applicable to the current workflow only, and cannot be used in another workflow.
- A workflow cannot use custom status values that you define in the action if the action is used inside an impersonation step.
If the Set Workflow Status action is the last step in your workflow where you have also used a custom value, you can see your custom value in the Status column in the list upon workflow pausing or completion.
Following is an example of what the action might look like in a workflow step,
Set workflow status to Specification status: Ready for Design Review
|
| Set Workflow Variable |
This action is initially displayed in a workflow steps as Set workflow variable to value. Use this action to set a workflow variable to a value. Use this action when you want the workflow to assign data to a variable.
Following is an example of what the action might look like in a workflow step,
Set Variable: Expense report total to Current Item:Total
|
| Stop Workflow |
This action is initially displayed in a workflow step as Stop workflow and log this message. Use this action to stop the current instance of the workflow and log a message to the Workflow History list. The message that you specify in the action will appear in the Description column in the Workflow History upon workflow completion.
Following is an example of what the action might look like in a workflow step,
Stop workflow and log Workflow exceeded maximum duration
|
| List Actions |
This category of actions performs operations on list items.
Note Some actions in this category appear only in a particular workflow context. For example, some list actions only appear when you click inside an impersonation step in your workflow, while some appear only when your workflow is attached to a document content type. For more information, see Actions available within an impersonation step and Actions available when the workflow is associated to a document content type.
|
| Check In Item |
This action is initially displayed in a workflow step as Check in item in this list with comment: comment. Checks in an item that is checked out.
Following is an example of what the action might look like in a workflow step,
Check in item in Expense Reports with comment: Expense report approved
Note You can only check in items from a document library.
|
| Check Out Item |
This action is initially displayed in a workflow step as Check out item in this list. Use this action to check out an item.
Following is an example of what the action might look like in a workflow step,
Check out item in Current Item
Notes
- You can only check out items from a library in your site
The workflow verifies if the item is checked in, before it checks out a document
|
| Copy List Item |
This action is initially displayed in a workflow step as Copy item in this list to this list. Use this action to copy a list item to another list. If there is a document in the list item, the workflow also copies the document to the destination list.
Following is an example of what the action might look like in a workflow step,
Copy item in Current Item to Archive Requests
Important You must have at least one column similar in both the source and destination lists
|
| Create List Item |
This action is initially displayed in a workflow step as Create item in the list (Output to Variable: create). Use this action to create a new list item in the list that you specify. You can supply the fields and values in the new item.
You can use this action whenever you want a new item to be created with specific information. For example, create announcements whenever important company-related documents such as contracts are approved, or archive documents.
Note The output variable is the ID of the item created in the list.
Following is an example of what the action might look like in a workflow step,
Create item in Orders (Output to Variable: New Order ID)
|
| Delete Item |
This action is initially displayed in a workflow steps as Delete item in this list. Use this action to delete an item.
Following is an example of what the action might look like in a workflow step,
Delete item in Documents
|
| Discard Check Out Item |
This action is initially displayed in a workflow step as Discard check out of item in this list. Use this action if an item is checked out, changes have been made to it, and you want to get rid of the changes and check the item back in.
Following is an example of what the action might look like in a workflow step,
Discard check out of item in Documents
|
| Set Content Approval Status |
This action is initially displayed in a workflow step as Set content approval status to this status with comments If you have content approval enabled in your list, use this action to set the content approval status field to a value such as Approved, Rejected, or Pending. You can type a custom status in the action.
Following is an example of what the action might look like in a workflow step,
Set content approval status to Approved with Looks good
Notes
- Content approval needs to be enabled in the list in order to be able to use this action.
The Set Content Approval Status action works on the current item that the workflow is acting upon, therefore the action is not available in a site workflow.
|
| Set Field in Current Item |
This action is initially displayed in a workflow step as Set filed to value Use the action to set a field in the current item to a value.
Following is an example of what the action might look like in a workflow step,
Set Content Type ID to Specification
Notes
- If you want to pause the workflow until it changes the value of the field, use the Wait for Field Change in Current Item action instead.
The Set Field in Current Item action is not available when you are working in a site workflow.
|
| Update List Item |
This action is initially displayed in a workflow step as Update item in list Use this action to update a list item. You can specify the fields and the new values in those fields.
Following is an example of what the action might look like in a workflow step,
Update item in Documents
|
| Wait for Field Change in Current Item |
This action is initially displayed in a workflow steps as Wait for field to equal value. This action pauses the workflow until the field in the current item has changed to a new value.
Following is an example of what the action might look like in a workflow step,
Wait for Approval Status to equal 1;#Rejected
Note If you want the workflow to change the value of the field, rather than have the workflow wait for the field to change, use the Set Field in Current Item action instead.
|
| Task Actions |
Actions in this category are pertinent to task items. |
| Assign a Form to a Group |
This action is initially displayed in a workflow step as Assign a custom form to these users. It enables you to create a custom task form with customized fields.
You can use this action to assign a task to one or more participants or groups prompting them to perform their tasks. Participants provide their responses it the fields of the custom task form and, when they are done with the task, click Complete Task on the form.
Following is an example of what the action might look like in a workflow step,
Assign Asset Reporting to Marketing
Note There is not a return value that identifies the task data.
|
| Assign a To-do Item |
This action is initially displayed in a workflow step as Assign to-do to these users. Use this action to assign a task to each of the participants, prompting them to perform their tasks and then, when they are done, to click the Complete Task button on their task form.
Following is an example of what the action might look like in a workflow step,
Assign Submit expense report to Marketing
|
| Collect Data from a User |
This action is initially displayed in a workflow step as Collect data from this user (Output to Variable: collect). Use this action to assign a task to the participant, prompting them to provide the needed information in a custom task form, and then click the Complete Task button on the task form.
This action has an output clause— meaning, the workflow stores the information returned by the action in a corresponding variable. The list item ID of the completed task item from the action is stored in the collect variable.
Following is an example of what the action might look like in a workflow step,
Collect Expense report from Marketing (Output to Variable: Marketing Expense Report)
|
| Utility Actions |
Most actions in this category can be used to extract information from text strings.
You can cut up a text string and use it in several different scenarios in workflow. Suppose your company wants to stamp all incoming documents in a specific name format such as date_department (e.g. 07142009_sales.docx), and you want to run workflows that assign tasks to a reviewer based on the date in that file. You could use a utility action to get the first 8 characters of the document name (07142009) and convert it into a date using lookup coercions so that you can assign tasks with that due date.
For more information on lookup coercions, see the See Also section.
|
| Extract Substring from End of String |
This action is initially displayed in a workflow step as Copy 0 characters from then end of string (Output to Variable: substring). Use this action to copy n number of characters from the end of a string and store the output value in a variable. You have to define the number of characters that the workflow has to copy from the string.
Following is an example of what the action might look like in a workflow step,
Copy 15 characters from then end of Current Item:Name (Output to Variable: Copy15CharFromEndOfName)
|
| Extract Substring from Index of String |
This action is initially displayed in a workflow steps as Copy from string, starting at 0 (Output to substring). Use this action to copy all characters starting from character n in a string and store the output in a variable.
Following is an example of what the action might look like in a workflow step,
Copy from Current Item:Name , starting at 4 (Output to Variable: CopyStringFromChar4)
|
| Extract Substring from Start of String |
This action is initially displayed in workflow step as Copy 0 characters from the start of string (Output to Variable: substring). Use this action to copy n number of characters from the start of a string and stores the output in a variable. You must define the number of characters that the workflow has to copy from the string.
Following is an example of what the action might look like in a workflow step,
Copy 15 characters from then start of Current Item:Name (Output to Variable: Copy15CharFromStartOfName)
|
| Extract Substring of String from Index with Length |
This action is initially displayed in a workflow step as Copy from string, starting at 0 for 0 characters (Output to Variable: substring). Use this action to copy n number of characters starting from a particular character in a string and stores the output in a variable. You must define the number of characters that the workflow has to copy from the string.
Following is an example of what the action might look like in a workflow step,
Copy from Current Item:Name, starting at 4 for 15 characters (Output to Variable: Copyfrom Char4for15CharOfName)
|
| Find Interval Between Dates |
This action is initially displayed in a workflow step as Find minutes between date and date (Output to Variable: time). Use this action to calculate the time difference, in terms of minutes, hours or days, between two dates and stores the output in a variable.
Following is an example of what the action might look like in a workflow step,
Find minutes between CurrentItem:Modified and Today (Output to Variable: Last Modified In Minutes)
|