List Activities on Virtosoftware Guides & Docs

Waiting For Changes Fields

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

This activity intended to waiting for field changes in current item. Activity triggers after value changing in some field of the current item.

SharePoint Designer phrase

Parameters#

Output parameters

Parameter	Description	Example
Changes	The dictionary that represents the changesStructure of the changes dictionary:- (0)FieldBeforeValueAfterValue- (1)FieldBeforeValueAfterValue	Variable:changes

Input parameters

Parameter	Description	Example
Field Names	Comma separated list ofinternal field names to track	Status; Priority

Example

Get Attachments

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

Activity allows to get attachments from list item and save is as dictionary. SharePoint Designer phrase

Parameters#

Output parameters

Parameter	Description	Example
Attachments	The dictionary that representsthe attachments	Variable:attachments

Input parameters

Parameter	Description	Example
ItemID	The ID of the sourceitem.	Variable:ItemID
List identifier	The list where the item will be stored. The value could be list name, guid or list url (the web site relative URL. If the value field is empty, current list willbe used.	[%Workflow Context: List ID %]/Lists/Tasks Tasks
SiteURL	The URL of a SharePoint site. If the value field is empty, current site will beused.	[%Workflow Context:Current Site URL%]/ https://contoso/SiteUrl/

Example

Copy/Move Attachments

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

This activity allows to copy/move attachments from list item to other folder. Cross site copy is supported.

SharePoint Designer phrase

Parameters#

Output parameters

Parameter	Description	Example
URLs	Returns a list of copied files	Variable:fileURLs

Input parameters

Parameter	Description	Example
Method	Copy or Move	Copy(0), Move(1)
ItemID	The ID of the source item.	Variable:ItemID
List identifier	The list where the item	[%Workflow Context: List ID %]

	will be stored. The value could be list name, guid or list url (the web site relative URL). If the value field is empty, current listwill be used.	/Lists/Tasks Tasks
DestinationUrl	The URL where the source folder will be copied/moved. You can use absolute URL as well as web site relative URL	https://contoso/SiteUrl/LibraryName/FolderNa me[%Workflow Context:Current Site URL%]/siteURL/Source Documents/Documents/
SiteURL	The URL of a SharePoint site. If the value field is empty, current site will beused.	[%Workflow Context:Current Site URL%]/ https://contoso/SiteUrl/
Overwrite	Overwrite a file if thereis a file with the same name	Yes/No

Example

Copy/Move Folder

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

This activity allows to copy/move a folder in other folder. Cross site copy is supported. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
Method	Copy or Move	Copy(0), Move(1)
SourceUrl	The URL of the folder to be copied/moved. You can use absolute URL as well as web site relative URL.	[%Current Item: Encoded Absolute URL%]/Source Documents/folderhttps://contoso/SiteUrl/LibraryName/FolderNa me[%Workflow Context:Current Site URL%]/siteURL//Source Documents//Documents/
DestinationUrl	The URL where the source folder will be copied/moved. You can use absolute URL as well as web site relative URL	https://contoso/SiteUrl/LibraryName/FolderNa me[%Workflow Context:Current Site URL%]/siteURL/Source Documents/Documents/
SiteURL	The URL of a	[%Workflow Context:Current Site URL%]/

	SharePoint site. If the value field is empty, current site will beused.	https://contoso/SiteUrl/
Overwrite	Overwrite a file if there is a file with the samename	Yes/No
OnlyContent	if it is yes, will be processed only the content of a folder will be processed	Yes/No

Example

Add/Remove folder

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

This activity allows to delete or create folder in a list or in a library on specified site. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
Method	Add or Remove	Add(0),Remove(1)
List identifier	The URL of the library or of the list where the folder will be created/removed. The value could be list name, guid or list url (the web site relative URL. If the value field is empty,current list will be used.	Documents[%Workflow Context: List ID %]/Lists/Tasks
Site URL	The URL of a SharePoint site. If the value field is empty, current list will be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl; [%Workflow Context:Current Site URL%]subSite
Folder Path	The path where the folder will be created/removed. The workflow action will create all folders included into the path. You can use absolute URL, domain relative URL, site relative URL, listrelative URL	http://contoso/sites/site/Lists/ListName/Folder1/SubFolder/sites/site/Lists/ListName/Folder1/SubFolder/Lists/ListName/Folder1/SubFolder/Folder1/SubFolder

Example

Update List Item

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

This activity updates the list item on any site. SharePoint Designer phrase

Parameters#

Input parameters

Example

Create List Item

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

This activity creates list item on any site. SharePoint Designer phrase

Parameters#

Output parameters

Parameter	Description	Example
itemID	ID of created item	Variable:ItemID

Input parameters

Parameter	Description	Example
List identifier	The list where the item will be created. The value could be list name, guid or list URL (the web site relative URL). If the value field is empty, current listwill be used.	Documents[%Workflow Context: List ID %]/Lists/Tasks
FieldValues	Dictionary contains field values for setting in created item. You can specify fields using Display Name, Internal Name or GUID.	[{ 'Title' : 'New Item' },{ 'FieldName' : 'FieldValue' }]

Copy/Move Document

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

Activity allows to copy/move document to a folder. Cross site copy/move is also supported. SharePoint Designer phrase

Parameters#

Input parameters

Parameter	Description	Example
Method	Copy or Move	Copy(0), Move(1)
SourceUrl	The URL of the document to be copied/moved. You can use absolute URL as well as web site relative URL.	[%Current Item: Encoded Absolute URL%]/Source Documents/report.xlshttps://contoso/SiteUrl/LibraryName/FolderNa me/DocumentName.docx[%Workflow Context:Current Site URL%]/siteURL//Source Documents/report5.xls/Documents/report.xls
DestinationUrl	The URL where the source document will be copied/moved. You can use absolute URL as well as web site relative URL	https://contoso/SiteUrl/LibraryName/FolderNa me[%Workflow Context:Current Site URL%]/siteURL/Source Documents/Documents/
SiteURL	The URL of a SharePoint site. If the value field is empty, current site will beused.	[%Workflow Context:Current Site URL%]/ https://contoso/SiteUrl/
Overwrite	Overwrite a file if there is a file with the same name	Yes/No

Example

Get List Items

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

This activity allows getting list items using Caml Query from any site. SharePoint Designer phrase

Parameters#

Output parameters

Parameter	Description	Example
Items	The dictionary that representsthe items	Variable:Items
Item Count	The number of items in thedictionary	Variable:Count

Input parameters

Parameter	Description	Example
List identifier	List for querying. The value could be list name, list base template, guid (not supported with multiple sites) or list URL (The web site relative URL). ). If the value field is empty, current list will beused.	Documents[%Workflow Context: List ID %] 107/Lists/Tasks
Caml Query	CAML query that will be run	<View Scope='RecursiveAll'><Query><Where><Contains><FieldRef Name='FileLeafRef' /><Value Type='File'> .docx </Value></Contains></Where>

		<OrderBy><FieldRef Name='ID' /></OrderBy></Query><ViewFields><FieldRef Name='FileLeafRef' /><FieldRef Name='FileRef' /></ViewFields><RowLimit>10</RowLimit></View>
Folder Path	The web site relative URL of a list folder from whichresults will be returned	/Lists/ListName/Folder1/SubFolder
Site URLs	The URLs of a SharePoint sites (semicolon delimited). If the valuefield is empty, current site will be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]subSite

Example