List Activities on Virtosoftware Guides & Docs

Get current list item attachments urls

Thu, 24 Oct 2024 18:20:54 +0000

This activity retrieves the URLs of item attachments and stores the result in a variable.

SharePoint Workflow Designer Phrase#

Get current item attachments URLs and store the result in variable.

Parameters#

Parameter	Description
variable	The output variable where the result will be stored.

Throws an error if either the user or property does not exist.

Create task

Thu, 24 Oct 2024 18:20:47 +0000

This activity creates a SharePoint task and returns the task ID.

Note: Using this activity, you can create child tasks for a new element. For example, a user creates a “Summary Task 1,” and the workflow can then create “Task 2” as a child of “Summary Task 1,” and so on.

SharePoint Workflow Designer Phrase#

Create a new task this title from start date to due date in parent task with bulk update at this list URL. Trigger create event: No. Store new task ID in variable.

Create Summary task

Thu, 24 Oct 2024 18:20:39 +0000

This activity creates a summary task and returns the summary task ID, which you can use as a parent task.

Note: This activity allows you to create child summary tasks for new elements. For example, a user creates “Summary Task 1,” and the workflow then creates “Summary Task 2” as a child of “Summary Task 1,” followed by “Summary Task 3” as a child of “Summary Task 2,” and so on.

Get version history of list item

Thu, 24 Oct 2024 18:20:30 +0000

This activity provides access to the version history of a list item and stores the result in a variable. You can retrieve the first value, the previous value (useful for checking if an item has changed), or the last different value. The activity supports all SharePoint columns.

SharePoint Workflow Designer Phrase#

Get First Value from the version history of this item for this field and store it in variable.

Parameters

Get field values from list

Thu, 24 Oct 2024 18:20:23 +0000

This activity extracts values from a specified field in Text, HTML, Edit Mode, and Internal formats from filtered list items in a specified list and stores the result in an array.

SharePoint Workflow Designer Phrase#

Get values from this field at this list item URL and store the result in variable.

Parameters

Parameter	Description
Text	Format: Text: The value as plain text, without any formatting. Html: The value in HTML format. Edit Mode: The field value as rendered in Edit mode. Internal: The value in SharePoint's internal format.
all	Optional. A list item filter. The filter string supports View Name, View ID, and CAML string (`<Where>...</Where>`). Leaving the filter empty returns all items.
this field	The name of the field to extract values from.
list URL	Optional. The source list. The default value is the current list. Examples: `http://mysharepoint/MyDocs/Shared%20Documents` `http://mysharepoint/Lists/List%20with%20Approve`

Get emails from field extended

Thu, 24 Oct 2024 18:20:14 +0000

This activity locates a list item by its URL, extracts all email addresses from a specified field, and stores the result in a variable.

The activity reads the value from the specified field and returns a string of unique email addresses, concatenated by a semicolon (“;”).

It supports automatic detection of email addresses from user strings (DOMAIN\userName) and SPUser(s) objects.

SharePoint Workflow Designer Phrase#

Get emails from this field at this list item URL and store the result in variable.

Get emails from List field extended

Thu, 24 Oct 2024 18:20:07 +0000

This activity extracts all email addresses from a specified field in filtered list items and stores the result in a variable.

You can use it to retrieve email recipients from an external list. The activity enumerates list items, extracts emails from a specific field, and returns a string of unique email addresses concatenated by a semicolon (“;”).

This activity supports automatic detection of email addresses from user strings (DOMAIN\userName) and SPUser(s) objects.

Remove all attachments

Thu, 24 Oct 2024 18:19:59 +0000

This activity removes all attachments from a list item.

SharePoint Workflow Designer Phrase#

Remove all attachments from the list item at this list item URL.

Parameters

Parameter	Description
this list item URL	Optional. The full URL of the list item. If this URL is empty, attachments will be removed from the current item. Examples: `http://mysharepoint/Lists/List%20with%20Approve/1_.000` `http://mysharepoint/Lists/List%20with%20Approve/DispForm.aspx?ID=1` `http://mysharepoint/Lists/List%20with%20Approve/EditForm.aspx?ID=1`

Remove attachment

Thu, 24 Oct 2024 18:19:52 +0000

This activity removes an attachment by file name or index from the specified list item.

SharePoint Workflow Designer Phrase#

Remove file name attachment from list item at this list item.

Parameters

Parameter	Description
file name	Attachment’s file name or index in the attachment collection.
this list item URL	Optional. Full list item URL. If the list item URL is empty, attachments will be removed from the current item. Examples: `http://mysharepoint/Lists/List%20with%20Approve/1_.000` `http://mysharepoint/Lists/List%20with%20Approve/DispForm.aspx?ID=1` `http://mysharepoint/Lists/List%20with%20Approve/EditForm.aspx?ID=1`

Upload attachments

Thu, 24 Oct 2024 18:19:45 +0000

This activity uploads list item attachments from a SharePoint Document Library, web, or local disk. The attachments multiline text field supports URLs and local disk paths. Both HTTP and HTTPS requests are supported.

SharePoint Workflow Designer Phrase#

Upload this attachments to list item at this list item url.

Parameters

Parameter	Description
this attachments	List of attachments. Each attachment can be a file path or a web link. Examples: `http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf` `c:\publicfolder\report.pdf` `http://externalserver/report.pdf`
this list item URL	Optional. Full list item URL. If the list item URL is empty, attachments will be uploaded to the current item. Examples: `http://mysharepoint/Lists/List%20with%20Approve/1_.000` `http://mysharepoint/Lists/List%20with%20Approve/DispForm.aspx?ID=1` `http://mysharepoint/Lists/List%20with%20Approve/EditForm.aspx?ID=1`

Get list item url

Thu, 24 Oct 2024 18:19:38 +0000

This activity returns the Display Form, Edit Form, and Native URL for a selected list item.

SharePoint Workflow Designer Phrase#

Get Display Form URL for this list item and store result in variable.

Parameters

Parameter	Description
Display Form	Output URL format: - Display Form – link to the list item’s display form - Edit Form – link to the list item’s edit form - Native Form – internal SharePoint list item URL
this list item	Selected list item.

Wait For Field Change in current item with Timeout

Thu, 24 Oct 2024 18:19:30 +0000

This activity waits for field changes periodically in the current item with a timeout and stores the timeout result in a variable.

Note: The default “Wait For Field Change in Current Item” activity:

Doesn’t detect code or workflow modifications
Doesn’t detect status modifications
Doesn’t have a timeout

You can use this activity to implement a “wait for field change” logic with a timeout and process custom logic using the timeout result. For example, send a notification email if a timeout occurs.

Copy List attachments to Document Library

Thu, 24 Oct 2024 18:19:21 +0000

This activity copies list item attachments to a document library.

You can use the bulk update property to update fields for all copied files.

SharePoint Workflow Designer Phrase#

Copy this item attachments to list url, Overwrite existing items. Use bulk update to update fields.

Parameters#

Parameter	Description
this item	List item from which to extract attachments.
list URL	Parent folder URL. Example: `http://mycompanydomain/site/doclib/subfolder`
Overwrite	Indicates that the activity overwrites existing files if they are already present.
bulk update	Optional. Bulk update string. Includes field names and values as lines: `[FieldName1]=[Value1]…[FieldNameN]=[ValueN]` Notes: Use `vti_title` to update the title. Use `ModerationInformation.Status` to update the content approval status. Use `ModerationInformation.Comment` to update comments explaining why the item was approved or rejected. Example: `Description=Test Description` `Start Date=2010-12-10T12:30:00` `Published=1` `Choice=My Choice #3` `Lookup=12;#` `vti_title=My Super Title`

Change list item content type

Thu, 24 Oct 2024 18:19:13 +0000

This activity locates a list item by its URL and changes the list item’s content type.

You can use the “Check Out Item Extended” and “Check In Item Extended” activities to check out and check in a list item before making modifications.

Note: You can use Content Types as Statuses, find more information here.

Note: If the URL is empty, the current list item will be used.

SharePoint Workflow Designer Phrase#

Set this content type as the content type for the list item at the specified URL.

Update List Item extended

Thu, 24 Oct 2024 18:19:05 +0000

This activity finds the list item by URL and updates multiple fields. The activity triggers an update event.

SharePoint Workflow Designer Phrase#

Update bulk update at list item URL. Trigger update event No.

Parameters

Parameter	Description
bulk update	Bulk update string. Includes field name and field value lines: `[FieldName1]=[Value1]…[FieldNameN]=[ValueN]`. Use string `<%FieldName%>` construction to resolve field value from the current list item. FieldName can be the field display name, field ID (GUID), or field index (int). Note: - Use `vti_title` field to update title - Use `ModerationInformation.Status` field to update content approval status for an item - Use `ModerationInformation.Comment` field to add a comment explaining why the item was approved or rejected. Example: Description=Test Description Start Date=2010-12-10T12:30:00 Published=1 Choice=My Choice #3 Lookup=12;# vti_title=My Super Title ModerationInformation.Status=Approved
this list item URL	Full URL of the list item. Examples: http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf http://mysharepoint/Lists/List%20with%20Approve/1_.000 http://mysharepoint/Lists/List%20with%20Approve/DispForm.aspx?ID=1 http://mysharepoint/Lists/List%20with%20Approve/EditForm.aspx?ID=1
No	Indicates if the activity triggers the item update event. Default value is No. Note: Can loop workflow activities if set to YES.

Create List Item extended

Thu, 24 Oct 2024 18:18:55 +0000

This activity locates a list by its URL and creates a list item. The activity can trigger a create event.

SharePoint Workflow Designer Phrase#

Create a list item with bulk update at this list URL. Trigger create event: No. Store the new list item ID in variable.

Parameters

Parameter	Description
bulk update	A bulk update string, containing field names and their respective values. Format: `[FieldName1]=[Value1] … [FieldNameN]=[ValueN]` Note: - Use the vti_title field to update the title. - Use the ModerationInformation.Status field to update the content approval status of an item. - Use the ModerationInformation.Comment field to add a comment explaining why the item was approved or rejected. Example: Description=Test Description Start Date=2010-12-10T12:30:00 Published=1 Choice=My Choice #3 Lookup=12;# vti_title=My Super Title ModerationInformation.Status=Approved
this list URL	The full URL of the list. Examples: `http://mysharepoint/MyDocs/Shared%20Documents` `http://mysharepoint/Lists/List%20with%20Approve`
No	Indicates if the activity triggers an item creation event. Default value is No.
Variable	Stores the newly created list item ID.

Set Field extended

Thu, 24 Oct 2024 18:18:48 +0000

This activity locates a list item by its URL and updates the value of a specified field. The activity runs associated workflows after the update.

SharePoint Workflow Designer Phrase#

Set field to value at list item URL. Trigger update event: No

Parameters

Parameter	Description
Field	The field's display name, unique ID (GUID), or index (int).
Value	The new value to set.
this list item URL	The full URL of the list item. Examples: `http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf` `http://mysharepoint/Lists/List%20with%20Approve/1_.000` `http://mysharepoint/Lists/List%20with%20Approve/DispForm.aspx?ID=1` `http://mysharepoint/Lists/List%20with%20Approve/EditForm.aspx?ID=1`
No	Indicates whether the activity triggers the item update event. Default value is No. Note: Setting this to Yes may cause workflow activities to loop.

Get field value extended

Thu, 24 Oct 2024 18:18:40 +0000

This activity locates a list item by its URL, retrieves the value from a specified field, and stores the result in a variable.

SharePoint Workflow Designer Phrase#

Get value from this field at list item URL and store the result in variable.

Parameters

Parameter	Description
this field	The field's display name, unique ID (GUID), or index (int).
this list item URL	The full URL of the list item. Examples: `http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf` `http://mysharepoint/Lists/List%20with%20Approve/1_.000` `http://mysharepoint/Lists/List%20with%20Approve/DispForm.aspx?ID=1` `http://mysharepoint/Lists/List%20with%20Approve/EditForm.aspx?ID=1`

Delete List Items extended

Thu, 24 Oct 2024 18:18:32 +0000

This activity locates a list by its URL and enables looping through list items to delete them.

SharePoint Workflow Designer Phrase#

Delete all items at list URL.

Parameters

Parameter	Description
All	Optional: A list item filter. The filter string supports View Name, View Name, View ID, and CAML string (<Where>...</Where>). Leaving the filter empty deletes all items.
list URL	The full URL of the list. Examples: `http://mysharepoint/MyDocs/Shared%20Documents` `http://mysharepoint/Lists/List%20with%20Approve`

Delete Item extended

Thu, 24 Oct 2024 18:18:25 +0000

This activity deletes the item by its URL.

SharePoint Workflow Designer Phrase#

Check out item at this list item URL.

Parameters

Parameter	Description
this list item URL	The full URL of the list item to delete. Examples: `http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf` `http://mysharepoint/Lists/List%20with%20Approve/1_.000` `http://mysharepoint/Lists/List%20with%20Approve/DispForm.aspx?ID=1` `http://mysharepoint/Lists/List%20with%20Approve/EditForm.aspx?ID=1`

Reject Item

Thu, 24 Oct 2024 18:18:18 +0000

This activity rejects the item, returning it to its creator, and it will not appear in public views.

SharePoint Workflow Designer Phrase

Reject this list item with comment: comment.

Parameters

Parameter	Description
this list item	The list item to reject.
Comment	Optional. A string that contains the comment.

Approve Item extended

Thu, 24 Oct 2024 18:18:11 +0000

This activity approves the item by list URL, making it visible to all users.

SharePoint Workflow Designer Phrase#

Approve this list item URL with comment: comment.

Parameters

Parameter	Description
this list item URL	Full list item URL to approve. Examples: http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf http://mysharepoint/Lists/List%20with%20Approve/1_.000 http://mysharepoint/Lists/List%20with%20Approve/DispForm.aspx?ID=1 http://mysharepoint/Lists/List%20with%20Approve/EditForm.aspx?ID=1
Comment	Optional. A string that contains the comment.

Approve Item

Thu, 24 Oct 2024 18:18:03 +0000

This activity approves the item, making it visible to all users.

SharePoint Workflow Designer Phrase

Approve this list item with comment: comment.

Parameters:

Parameter	Description
this list item	The list item to approve.
Comment	Optional. A string that contains a comment.

Generate Report extended

Thu, 24 Oct 2024 18:17:55 +0000

This activity generates a text report from filtered list items as a data source.

The activity loads selected items from the list, creates a text report (see schema below), and stores the result in a text variable. You can use HTML tags to format the report.

This activity can be useful in many scenarios, such as:

Creating a report of a user’s active jobs, adding it to an email body, and sending the email.
Creating a client incidents report, adding it to an email body, and sending it to the client.
Generating an administrator’s warnings report, adding it to an SMS message, and sending it.
Creating dynamic CAML queries.
Generating dynamic email, SMS, or instant message contact lists.
Creating any text-based documents (e.g., HTML, XML).

Report Schema:#

[Header]
[Row for List Item 1]
[Row for List Item 2]
…
[Row for List Item N]
[Footer]

To display field values from the current list item in the Row Template, use the <%FieldName%> construction. This is an active text marker: the activity identifies the marker, retrieves the field value, and replaces the marker with the value in text format.

Generate Report

Thu, 24 Oct 2024 18:17:47 +0000

This activity generates a text report from filtered list items as a data source.

The activity loads selected items from the list, creates a text report (see schema below), and stores the result in a text variable. You can use HTML tags to format the report.

This activity can be useful in many scenarios, such as:

Creating a report of a user’s active jobs, adding it to an email body, and sending the email.
Creating a client incidents report, adding it to an email body, and sending it to the client.
Generating an administrator’s warnings report, adding it to an SMS message, and sending it.
Creating dynamic CAML queries.
Generating dynamic email, SMS, or instant message contact lists.
Creating any text-based documents (e.g., HTML, XML).

Report schema:#

[Header]
[Row for List Item 1]
[Row for List Item 2]
…
[Row for List Item N]
[Footer]

Get emails from field in Current Item

Thu, 24 Oct 2024 18:17:37 +0000

This activity extracts all emails from a field in the current list item and stores the result in a variable.

It reads the field value from the specified field and returns a string with unique emails concatenated by a semicolon (“;”).

Supports automatic detection of emails from user strings (e.g., DOMAIN\userName) and SPUser(s) objects.

SharePoint Workflow Designer Phrase#

Get emails from field and store result in variable.

Parameters

Get emails from List field

Thu, 24 Oct 2024 18:17:29 +0000

This activity extracts all emails from a field in filtered list items and stores the result in a variable.

You can use this to retrieve email recipients from an external list. The activity enumerates list items, extracts emails from the specified field, and returns a string with unique emails concatenated by a semicolon (“;”).

Supports automatic detection of emails from user strings (e.g., DOMAIN\userName) and SPUser(s) objects.

SharePoint Workflow Designer Phrase#

Get emails from all items, from this field in current list and store result in variable.

Calculate aggregate function extended

Thu, 24 Oct 2024 18:17:23 +0000

This activity finds a list by URL, calculates an aggregate numerical function from a numeric column for selected items in the list, and stores the result in a variable.

SharePoint Workflow Designer Phrase#

Calculate this function on this field from all items at list URL and store result in variable.

Parameters

Parameter Description

this function Name of the aggregate function. Available functions: Count, Sum, Avg, Min, Max, Standard Deviation, Mode.

this field

Optional. Numerical field on which the mathematical function will be performed. Can be specified by field display name, unique ID (GUID), or field index (int). Not required for the Count function.

All

Optional. List item filter. The filter string supports View Name, View ID, and CAML string (<Where>...</Where>). An empty filter returns all items.

list url Full list URL
Examples:
http://mysharepoint/MyDocs/Shared%20Documents
http://mysharepoint/Lists/List%20with%20Approve

Variable This activity will place the function result into an output variable (Double).

Available Functions

Calculate aggregate function

Thu, 24 Oct 2024 18:17:16 +0000

This activity calculates an aggregate numerical function from a numeric column for selected items in a list and stores the result in a variable.

SharePoint Workflow Designer Phrase#

Calculate this function on this field from all items in this list and store result in variable.

Parameters

Parameter

Description

this function

Name of the aggregate function. Available functions: Count, Sum, Avg, Min, Max, Standard Deviation, Mode.

this field

All

Optional. List item filter. The filter string supports View Name, View ID, and CAML string (<Where>...</Where>). An empty filter returns all items.

this list

Source list

Variable

This activity will place the function result into an output variable (Double).

Available Functions

Delete List Items

Thu, 24 Oct 2024 18:17:09 +0000

This activity allows looping through list items and deleting items.

SharePoint Workflow Designer Phrase#

Delete all items.

Parameters

Parameter	Description
All	Optional. List item filter. The filter string supports View Name, View ID, and CAML string (`<Where>...</Where>`). An empty filter deletes all items.

Loop through list items and update list items extended

Thu, 24 Oct 2024 18:17:00 +0000

This activity finds a list by URL and allows looping through list items to update multiple fields for each item.

SharePoint Workflow Designer Phrase#

Loop through all items and apply bulk update at list URL. Trigger update event No.

Parameters

Parameter Description

all

Optional. List item filter. The filter string supports View Name, View ID, and CAML string (<Where>...</Where>). An empty filter returns all items.

bulk update Bulk update string that includes field name and field value lines in the format [FieldName1]=[Value1] … [FieldNameN]=[ValueN]. Use the <%FieldName%> construction to resolve field values from the current list item. FieldName can be a field display name, field ID (GUID), or field index (int).
Note:
- Use vti_title to update the title.
- Use ModerationInformation.Status to update the content approval status.
- Use ModerationInformation.Comment to add a comment explaining why the item was approved or rejected.
Example:
Description=Test Description
Start Date=2010-12-10T12:30:00
Published=1
Choice=My Choice #3
Lookup=12;#
vti_title=My Super Title
ModerationInformation.Status=Approved

list URL Full URL of the list.
Examples:
http://mysharepoint/MyDocs/Shared%20Documents
http://mysharepoint/Lists/List%20with%20Approve

No Indicates whether the activity triggers the item update event. Default value is No.
Note: Can loop workflow activities if set to Yes.

Loop through list items and set the value of field extended

Thu, 24 Oct 2024 18:16:49 +0000

This activity finds a list by URL and allows looping through list items to set the value of a field.

SharePoint Workflow Designer Phrase#

Loop through all items and set field to value. Trigger update event No.

Parameters

Parameter Description

All

Optional. List item filter. The filter string supports View Name, View ID, and CAML string (<Where>...</Where>). An empty filter returns all items.

Field

Optional. Name of the field to update.

Value

Optional. New value to set for the field.

list url Full URL of the list.
Examples:
http://mysharepoint/MyDocs/Shared%20Documents
http://mysharepoint/Lists/List%20with%20Approve

No Indicates whether the activity triggers the item update event. Default value is No.
Note: Can loop workflow activities if set to Yes.

Loop through list items and update list items

Thu, 24 Oct 2024 18:16:41 +0000

This activity allows looping through list items and updating multiple fields for each list item.

The activity uses the default “Update List Item” user interface to select fields. You may ignore any “warning” messages, as the activity will only use the list ID, property name, and value from the control.

SharePoint Workflow Designer Phrase#

Loop through all items and update items in this list. Trigger update event No.

Loop through list items and set the value of field

Thu, 24 Oct 2024 18:16:34 +0000

This activity allows looping through list items and setting the value of a field.

SharePoint Workflow Designer Phrase#

Loop through all items and set field to value. Trigger update event No.

Parameters

Parameter

Description

All

Optional. List item filter. The filter string supports View Name, View ID, and CAML string (<Where>...</Where>). An empty filter returns all items.

Field

Name of the field to update.

Value

New value to set for the field.

Indicates whether the activity triggers the item update event. Default is No.
Note: Can loop workflow activities if set to Yes.

Copy List Item extended (Free)

Thu, 24 Oct 2024 18:16:26 +0000

This action copies list items.

Feature Matrix#

Feature	List Items	Files	Notes
Copy Item	X	X
Move Item	X	X
Overwrite Item on Destination		X
Specify Destination Subfolders		X	When copying/moving files in and out of document libraries, a path to a subfolder can be specified as the destination (e.g., `http://moss/site/doclib/subfolder`).
Copy/Move File Attributes		X	When copying/moving files in and out of document libraries, any attributes that exist in the destination library are also set.
Copy/Move Item History	X		List item history is never kept; file version history is always copied/moved.
Copy/Move Item Attachments	X
Copy/Move Item Cross Site	X	X
Copy/Move Item with Person Fields Cross Site	X	X