Document Library Activities on Virtosoftware Guides & Docs

Convert Word document to PDF

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

This activity allows converting Word documents to PDF using SharePoint Server 2010 and Word Services.

Note: This activity uses SharePoint 2010 Word Automation Services, available with SharePoint Server 2010. After executing the activity, the file is added to the Timer Job schedule to be processed by SharePoint. The activity does not wait for the result.

Note: Supported file types include .docx, .docm, .dotx, .dotm, .doc, .dot, .rtf, .mht, .mhtml, and .xml (Word XML) files.

Create Document Set

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

This activity allows creating a new Document Set in the specified folder.

Note: You will need to activate the Document Set feature for the document library before you can create a Document Set. More info: Document Set Help

SharePoint Workflow Designer Phrase#

Create this name Document Set at parent folder URL

Parameters

Parameter	Description
this name	Name of the Document Set.
this parent folder URL	URL of the parent folder. Examples: `http://mycompanydomain/site/doclib` `http://mycompanydomain/site/doclib/subfolder`

Create SharePoint library

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

This activity allows creating a new Document, Form, Wiki Page, or Picture library at a specified site.

SharePoint Workflow Designer Phrase#

Create a new Document Library named this name, with description this description, at this site URL.

Parameters

Parameter	Description
Document Library	Type of library to create: Document Library, Form Library, Wiki Page Library, or Picture Library.
this name	Name of the library.
this description	Description of the library.
this site URL	Optional. The URL of the site where the library is being created. Default is the current site.

Read text content from document

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

This activity allows reading any text document (e.g., TXT, HTML, Email) and saving the result into a variable.

Note: Using this activity, you can retrieve information from an email that was saved in an email-enabled list.

SharePoint Workflow Designer Phrase#

Read text content from list item URL and store result in output text.

Parameters

Parameter	Description
list item URL	Optional. Full URL of the list item. Example: `http://mysharepoint/MyDocs/Shared%20Documents/Report.txt`. If the URL is empty, the current list item will be used.

Download documents to folder

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

This activity downloads SharePoint documents and folders to the local disk.

The following wildcard specifiers are permitted in the search pattern:

Wildcard character:#

*? - Exactly zero or one character.

* - Zero or more characters.

Characters other than the wildcard specifiers represent themselves. For example, the search pattern string “*t” searches for all names in the path ending with the letter “t.” The search pattern string “s*” searches for all names in the path beginning with the letter “s.”

Upload documents from folder

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

This activity uploads SharePoint documents and folders from the local disk.

The following wildcard specifiers are permitted in the search pattern:

Wildcard character:#

? - Exactly zero or one character.

* - Zero or more characters.

Characters other than the wildcard specifiers represent themselves. For example, the search pattern string “*t” searches for all names in the path ending with the letter “t”. The search pattern string “s*” searches for all names in the path beginning with the letter “s”.

Rename document

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

This activity finds the document by URL and sets a new document name and title.

Note: This activity doesn’t modify the file extension or content type.

SharePoint Workflow Designer Phrase#

Rename list item URL to new file name.

Parameters

Parameter	Description
this list item url	Optional. Full URL of the list item. Example: http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf. If the URL is empty, the current list item will be used.
new file name	The new file name, without the extension.

Create document from text

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

This activity allows you to create a text document (e.g., TXT, HTML) and save the result into a SharePoint document library or on the local disk.

Note: You can combine this activity with the “Generate report” activity to create professional HTML or TXT reports in SharePoint.

SharePoint Workflow Designer Phrase#

Create document from this text in file URL. Overwrite existing document.

Parameters

Parameter	Description
this text	Content of the text file.
file url	Full URL to a SharePoint file or path on the local disk. Example: `http://mysharepoint/MyDocs/Shared%20Documents/report.html` Example: `c:\Reports\SharePoint Report.txt`
Overwrite	Specifies whether to overwrite an existing file. Options: - Overwrite - Overwrites the existing file. - Do not Overwrite - Keeps the existing file.

Create document from file

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

This activity creates a new document from a specified file.

SharePoint Workflow Designer Phrase#

Create document from file path to parent folder URL. Overwrite existing document.

Parameters

Parameter	Description
file path	URL for the file containing the document to load. The URL can be either a local file or an HTTP URL (web address).
parent folder URL	Full URL to the destination folder. Example: `http://mysharepoint/MyDocs/Shared%20Documents`
Overwrite	Specifies whether to overwrite an existing file. Options: - Overwrite - Overwrites the existing file. - Do not Overwrite - Keeps the existing file. - Create unique name - Creates a unique file name if the file already exists.

Save document to file

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

This activity finds the document by URL and saves the file or attachments to an output folder on the local disk.

SharePoint Workflow Designer Phrase#

Save this list item URL to output folder. Overwrite existing file.

Parameters

Parameter	Description
this list item URL	Optional. Full URL of the list item. Example: http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf. If the URL is empty, the current list item will be used.
Output folder	Optional. The location of the folder where you want to save the document.
Overwrite	Specifies whether to overwrite an existing file on the local disk. Options: - Overwrite - Overwrites the existing file. - Do not Overwrite - Keeps the existing file. - Create unique name - Creates a unique file name if the file already exists.

Discard Publish Item extended

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

This activity finds the document by URL and removes the file from content approval with the specified comment.

SharePoint Workflow Designer Phrase#

Discard publish of this list item URL with comment: comment.

Parameters

Parameter	Description
this list item URL	Full URL of the list item to unpublish. Example: `http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf`
comment	Optional. A string that contains the comment.

Publish Item extended

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

This activity finds the document by URL and submits the file for content approval with the specified comment.

SharePoint Workflow Designer Phrase#

Publish this list item URL with comment: comment.

Parameters

Parameter	Description
this list item URL	Full URL of the list item to publish. Example: `http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf`
comment	Optional. A string that contains the comment.

Discard Publish Item

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

This activity removes the file from content approval with the specified comment.

SharePoint Workflow Designer Phrase#

Discard publish of this list item with comment: comment.

Parameters

Parameter	Description
this list item	File to unpublish.
comment	Optional. A string that contains the comment.

Publish Item

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

This activity submits the file for content approval with the specified comment.

SharePoint Workflow Designer Phrase

Publish this list item with comment: comment.

Parameters

Parameter	Description
this list item	File to publish
comment	Optional. A string that contains the comment.

Discard Check Out Item extended

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

This activity finds the document by URL and undoes the check-out of the document.

SharePoint Workflow Designer Phrase#

Discard check-out of item at this list item URL.

Parameters

Parameter	Description
this list item URL	Full URL of the list item to discard the check-out. Example: `http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf`

Check In Item extended

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

This activity finds the document by URL and checks in the specified document.

SharePoint Workflow Designer Phrase#

Check in item at this list item URL with comment: comment.

Parameters

Parameter	Description
this list item url	Full URL of the list item to check in. Example: `http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf`
comment	A string containing a comment about the check-in.

Check Out Item extended

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

This activity finds the document by URL and checks out the specified document.

SharePoint Workflow Designer Phrase#

Check out item at this list item URL.

Parameters

Parameter	Description
this list item URL	Full URL of the list item to check out. Example: `http://mysharepoint/MyDocs/Shared%20Documents/MSOMS.pdf`

Get parent folder URL

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

This activity returns the website-relative URL of the parent folder of an item.

SharePoint Workflow Designer Phrase#

Get parent folder URL from this item and store in variable.

Parameters#

Parameter	Description
this item	The current item.

If the parent folder is the root, the activity returns an empty string.

Get parent folder name

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

This activity returns the name of the parent folder of an item.

SharePoint Workflow Designer Phrase#

Get parent folder name from this item and store in variable.

Parameters#

Parameter	Description
this item	The current item

If the parent folder is the root, the activity returns an empty string.

Get parent folder ID (Free)

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

This activity returns the list item ID of the parent folder of an item.

SharePoint Workflow Designer Phrase#

Get parent folder ID from this item and store in variable.

Parameters#

Parameter	Description
this item	The current item

If the parent folder is the root, the activity returns 0.

Delete folder from the document library

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

This activity deletes a folder as specified by the folder name.

SharePoint Workflow Designer Phrase#

Delete this folder from the current folder.

Parameters#

Parameter	Description
this folder	Folder name. Supports multiple names separated by ‘\’ or ‘/’. For example, if the folder name is ‘My Folder1\My Folder2’, the activity will delete ‘My Folder2’ within ‘My Folder1’.
current folder	Specifies the parent of this folder: either the current folder or the document library root folder.

If the folder doesn’t exist, this method does nothing.

Create folder in the document library extended

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

This activity creates subfolders at the specified folder.

SharePoint Workflow Designer Phrase#

Create this folder at parent folder url.

Parameters#

Parameter	Description
this folder	New folder name. Supports multiple names separated by ‘\’ or ‘/’. For example, if the folder name is ‘My Folder1\My Folder2’, the activity will create the ‘My Folder1’ folder and subfolder ‘My Folder2’.
Parent folder url	URL of the parent folder. Example: `http://mycompanydomain/site/doclib/subfolder`

If the folder already exists, this method does nothing.

Create folder in the document library

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

This activity creates all folders and subfolders as specified by the folder name.

SharePoint Workflow Designer Phrase#

Create this folder in the current folder.

Parameters#

Parameter	Description
this folder	New folder name. Supports multiple names separated by ‘\’ or ‘/’. For example, if the folder name is ‘My Folder1\My Folder2’, the activity will create the ‘My Folder1’ folder and the subfolder ‘My Folder2’.
current folder	Specifies the parent of this folder: either the current folder or the document library root folder.

If the folder already exists, this method does nothing.