Administration Actions on Virtosoftware Guides & Docs

Update SharePoint site properties

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

This activity updates properties of a SharePoint site

SharePoint Workflow Designer Phrase#

Update variable properties on current site.

Parameters#

Input parameters

Parameter	Description	Example
Group properties variable	Dictionary variable which contains site properties	[%Variable:siteProperties%]
current site	Optional. Site where you want to updateproperties. If empty	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl; [%Workflow Context:Current Site URL%]/subSite

current site url will beused.

Example

Update SharePoint group properties

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

This activity updates properties of a SharePoint group

SharePoint Workflow Designer Phrase#

Update variable properties of the following group on current site.

Parameters#

Input parameters

Parameter	Description	Example
Group propertiesvariable	Dictionary variable which contains groupproperties	[%Variable:groupProperties%]
Thefollowing group	Group name or IDwhich properties you want to update.	Home owners, 4, Home Viewers
current site	Optional. Site where you want to update group properties. If empty current site urlwill be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl; [%Workflow Context:Current Site URL%]/subSite

Example

Start site workflow

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

This activity starts site workflow on a chosen site.

SharePoint Workflow Designer Phrase#

Start site workflow with the following name on current site.

Parameters#

Input parameters

Parameter	Description	Example
The following name	Workflow name which you want tostart on site
current site	Optional. Site where you want tostart	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl; [%Workflow Context:Current Site URL%]/subSite

workflow. If empty current site url will beused.

Example

Start list workflow

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

This activity starts list workflow on a chosen site.

SharePoint Workflow Designer Phrase#

Start list workflow with the following name on current list on current list item on current site.

Parameters#

Input parameters

Parameter	Description	Example
The following name	Workflow name which you want tostart on site	My custom workflow
current list	Optional. List name or id which you want to start workflow for. If empty current listwill be used.	Full list url Ex: http://mysharepoint/MyDocs/Shared%20Documents Ex: http://mysharepoint/Lists/List%20with%20Approve
current list item	Optional. List item or id which you want to start workflow for. If emptycurrent list	Full list item url Ex: http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf Ex: http://mysharepoint/Lists/List%20with%20Approve/1_.000 Ex: http://mysharepoint/Lists/List%20with%20Approve/DispForm.aspx?ID=1 Ex:http://mysharepoint/Lists/List%20with%20Approve/EditForm.aspx?ID=1

	item will beused.
current site	Optional. Site where you want to start workflow. If empty current site url will be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl; [%Workflow Context:Current Site URL%]/subSite

Example

Get site property as string

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

This activity represents requested site property as string.

SharePoint Workflow Designer Phrase#

Get the following property of current site as atring and save it to Variable: sprop variable.

Parameters#

Input parameters

Parameter	Description	Example
The followingproperty	Site property which youwant to get	MySiteProperty
current site	Optional. Site which property you want to get. Default value is current siteurl.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite
Variable: sprop	Result (set by this activity). After successful workflow execution contains requested site property.

Example

Delete SharePoint site collection

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

This activity completely deletes a top-level site and any subsites of that site on this web application.

SharePoint Workflow Designer Phrase#

Delete SharePoint site collection at the the following url.

Parameters#

Input parameters

Parameter	Description	Example
The followingurl	The URL of the sitecollection to be deleted.	https://contoso/SiteUrl;

Example

Delete SharePoint site

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

This activity deletes the SharePoint site by site url.

SharePoint Workflow Designer Phrase#

Delete SharePoint site at the the following url.

Parameters#

Input parameters

Parameter	Description	Example
The following url	The URL of the subsite to delete. Root site in sitecollection can`t be deleted.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

**Note:**Use Delete SharePoint site collection activity to delete parent site.

Example

Delete SharePoint list or document library

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

This activity removes SharePoint list or document library from the current site.

SharePoint Workflow Designer Phrase#

Delete the following list from current site.

Parameters#

Input parameters

Parameter	Description	Example
The following list	Name or Id (guid) of the SharePoint list or document library	My list04a03950-8f99-4ebd-9437-67be388e514c
current site	Optional. The URL of the site collection where the list or document library is being deleted. Default value iscurrent site collection.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Delete SharePoint group

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

This activity removes SharePoint group from the current site.

SharePoint Workflow Designer Phrase#

Delete the following SharePoint group from current site.

Parameters#

Input parameters

Parameter	Description	Example
The followinggroup	Name of the SharePointgroup
current site	Optional. The URL of the site collection where the group is being deleted.Default value is current site collection.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite

Example

Deactivate SharePoint feature

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

This activity deactivates a feature in the feature collection.

**Note:**You must first determine the scope of the feature. If the scope is Web-based or is a site collection scope, the url parameter is required. However, if the scope is farm-based, the url parameter is not required.

SharePoint Designer phrase

SharePoint Workflow Designer Phrase#

Deactivate the following feature on current site. Force Yes

Parameters#

Input parameters

Parameter	Description	Example
this feature	Feature Display name or Feature ID - GUID that identifies the featuredefinition to remove	Ex: Virto Alerts Customizer for SharePoint 04a03950-8f99-4ebd-9437-67be388e514c
current site	Optional. Complete site or web url. If url is empty, current url will be used. If feature’s scope is farm- based, the url parameter isnot required.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite
Force Yes	Specifies that an deactivation of the featurewill be forced	Yes No

Example

Create SharePoint site collection

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

This activity creates a new top-level Web site in the current web application.

**Note:**By defining managed paths, you can specify which paths in the URL namespace of a Web application are used for site collections. You can specify that one site collection or more than one site collection exists at a specified path. For example, an explicit path of hr indicates that the URL http://server/hr is a site collection, whereas a wildcard path of “sites” indicates that child URLs of http://server/sites/, such as server/sites/team, are site collections. To add a new URL Path go to the Define Managed Paths page (Central Administration > Application Management > Define Managed Paths).

Create SharePoint site

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

This activity creates a new SharePoint site or subsite at the specified URL.

SharePoint Workflow Designer Phrase#

Create new site with the following name, the following url and the following template in current site. Use the following description, use unique permissions No, use top link bar No from the parent site, display this site on Quick Launch No and on the Top Link Bar No of the parent site. Locale 1033

Create SharePoint list or document library

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

This activity creates a new SharePoint list or document library using specified template.

SharePoint Workflow Designer Phrase#

Create list with the following name and the following description using Generic list template on current site. Display on Quick Launch No. Save created list url in Variable: new list url variable.

Parameters#

Input parameters

Parameter	Description	Example
The followingname	Name of the newSharePoint list	The title of the new list. The maximum length is 255characters.
The followingdescription	Optional. Description ofthe new list or library.	My custom list
Generic list	Predefined list of available templates. Default value is Generic list corresponds to Custom list in SharePoint.	Generic list, Document Library, Links, Survey, etc.
Current site	Optional. The URL of a source SharePoint site. If the value field is empty,current site will be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite
Display on Quick Launch	Optional. Yes if the list appears on the Quick Launch area of thehomepage; otherwise, No.	Yes No
Variable: new list url	Set by this activity. The complete URL where the list should be created or empty value if create list inthe current site.	Example: http://server01

Example

Create SharePoint group

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

This activity adds a new SharePoint group to current site.

SharePoint Workflow Designer Phrase#

Create SharePoint group with the following name, this description description at current site and make this user the owner, give the following permissions, only Group Members can view, only Group Owner can edit, add the following members.

Parameters#

Input parameters

Parameter	Description	Example
The following group	Name of the new SharePoint group	My custom group, [%Variable:groupName%]
this description	Optional. Description ofthe new group.	My custom group with custom permissions
Current site	Optional. The URL of a source SharePoint site. If the value field is empty,current site will be used.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite
this user	Optional. Single User login or Group name. The owner can change anything about the group such as adding and removing members or deleting the group. Only one user or group can be the owner. If user is empty, the user who created the Web site will be used.	“user@domain”, “domain\user”. It allows multiple values separated by a semicolon.
the following permission	Optional. Permission level string. Multi permission assignments are supported. Use ‘,’ or ‘;’ separator togrant several permission.	Approve, Read, View Only.
Group Members	Specify who has permission to see the list of group members: Group Member(default) or Everyone.	“user@domain”, “domain\user”. It allows multiple values separated by a semicolon.
Group Owner	Specify who has permission to edit the list of group members: Group Owner(default) or Group Members	“user@domain”, “domain\user”. It allows multiple values separated by a semicolon.
the following members	Optional. The members of the group. Use ‘,’ or ‘;’ separator to identifymultiple users.	“DOMAIN\User_Alias; DOMAIN\User_Alias2”

Example

Activate SharePoint feature

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

This activity activates a feature in the feature collection.

SharePoint Designer phrase

SharePoint Workflow Designer Phrase#

Activate the following feature on current site. Force Yes

Parameters#

Input parameters

Parameter	Description	Example
this feature	Feature Display name or Feature ID - GUID that identifies the featuredefinition to add	Ex: Virto Alerts Customizer for SharePoint or 04a03950-8f99-4ebd-9437-67be388e514c
current site	Optional. Complete site or web url. If url is empty, current url will be used. If feature’s scope is farm- based, the url parameter isnot required.	https://contoso/SiteUrl; https://contoso/Sites/SiteUrl;[%Workflow Context:Current Site URL%]/subSite
Force Yes	Specifies that an activationof the feature will be forced	YesNo

Example