Configure the co-authoring versioning period in SharePoint Server

APPLIES TO: yes2013 yes2016 yes2019 noSharePoint Online

The CoauthoringVersionPeriod property specifies, in minutes, how often SharePoint stores a version of a document that is being edited. This article describes how to use Microsoft PowerShell to configure the CoauthoringVersionPeriod property. For more information about document library versioning, see Configure versioning for co-authoring in SharePoint 2013.

Configure the co-authoring versioning period in SharePoint Server 2013

When versioning is turned on, SharePoint Server 2013 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.

You can configure the CoauthoringVersionPeriod property by using the Microsoft PowerShell. If the value is set to 0, SharePoint Server 2013 captures 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 2013 creates one version for the whole editing session. This latter behavior matches the behavior of files that are not co-authored and files that were created in earlier versions of SharePoint Server 2013 or SharePoint Foundation.

To configure the co-authoring versioning period by using Windows PowerShell (save as script and run script)

  1. Verify that you have the following memberships:
  • securityadmin fixed server role on the SQL Server instance.

  • db_owner fixed database role on all databases that are to be updated.

  • Administrators group on the server on which you are running PowerShell cmdlets.

    An administrator can use the Add-SPShellAdmin cmdlet to grant permissions to use SharePoint Server 2013 cmdlets.

    Note

    If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see Permissions and Add-SPShellAdmin.

  1. Paste the following code into a text editor, such as Notepad:
$siteurl ="<ServerName>" 
$mysite=new-object Microsoft.SharePoint.SPSite($siteurl)
$mysite.WebApplication.WebService.CoauthoringVersionPeriod = <Time>
$mysite.WebApplication.WebService.Update()
  1. Specify the following parameters:

    Parameters to configure the co-authoring versioning period

Parameter Value
ServerName
Server name
Time
Number in minutes
  1. Save the file and add the .ps1 extension, such as SuggestedNameOfFile.ps1.

    Note

    You can use a different file name, but you must save the file as an ANSI-encoded text file whose extension is .ps1.

  2. Start the SharePoint 2013 Management Shell as Administrator.

  3. Change to the directory to which you saved the file.

  4. At the PowerShell command prompt, type the following command:

./SuggestedFileName.ps1

See also

Concepts

Configure versioning for co-authoring in SharePoint 2013

Overview of co-authoring in SharePoint Server