Configure the co-authoring versioning period (SharePoint Server 2010)

  • Article

 

Applies to: SharePoint Server 2010

This article describes how to configure the co-authoring versioning period in Microsoft SharePoint Server 2010 by using Windows PowerShell 2.0.

Configure the co-authoring versioning period

When versioning is turned on, SharePoint Server takes periodic snapshots of documents, saving them for later reference. This information can provide an edit trail that may be useful for seeing who changed a document, rolling back to an earlier version, or for compliance reasons.

The coAuthoringVersionPeriod property specifies how often SharePoint stores a version of a document that is being edited, measured in minutes. You can configure this property by using the Windows PowerShell. If the value is set to 0, SharePoint Server will capture every change made by a new user in a different version of the document. If the value is set to a very large number, SharePoint Server will create one version for the whole editing session. This latter behavior matches the behavior of files that are not co-authored and files in previous versions of SharePoint Server.

Note

Some procedures in this task require using Windows PowerShell or SharePoint 2010 Management Shell to run cmdlets. To run SharePoint 2010 cmdlets in Windows PowerShell, you must add the Microsoft.SharePoint.PowerShell snap-in by using the Add-PSSnapin cmdlet, or you can run the SharePoint 2010 cmdlets by using SharePoint 2010 Management Shell. By default, the Microsoft.SharePoint.PowerShell snap-in is already registered, and the snap-in is added to the SharePoint 2010 Management Shell. To run SharePoint 2010 cmdlets, you must be a member of the SharePoint_Shell_Access role on the configuration database and a member of the WSS_ADMIN_WPG local group on the computer where SharePoint 2010 Products is installed.
For more information about the Add-PSSnapin cmdlet, see Add-PSSnapin. For more information about how to use Windows PowerShell with SharePoint 2010 Products, see SharePoint 2010 Products administration by using Windows PowerShell.

To configure the co-authoring versioning period by using Windows PowerShell

  1. Using Notepad, open a new a text file and then copy and paste the following script into the file.

    $siteurl ="<ServerName>" 
$mysite=new-object Microsoft.SharePoint.SPSite($siteurl)
$mysite.WebApplication.WebService.CoauthoringVersionPeriod = minutes
$mysite.WebApplication.WebService.Update()

  2. Specify the following parameters:

    Parameter Value

    $siteurl

    Server name

    CoauthoringVersionPeriod

    Number in minutes

  3. Save the file with a .ps1 file name extension to a folder where you run scripts (typically C:\scripts).

  4. From the Windows PowerShell command prompt (that is, PS C:\>), type the following command and press ENTER:

    C:\<path>\<filename>.ps1

See Also

Concepts

Configure versioning for co-authoring (SharePoint Server 2010)