Set-CopyMoveFarmConfiguration

 Top  Previous  Next

Sets CopyMove configuration settings for the SharePoint farm.

Syntax

Set-CopyMoveFarmConfiguration [-AllowUserSites <bool>] [-CompatibleLists <string[]>] [-CopyExcludeProperties <string[]>] [-CopyPermissionsOptionState <CopyMoveOptionState> {Disabled | Unchecked | Checked | Hidden}] [-CopyPropertiesOptionState <Co

pyMoveOptionState> {Disabled | Unchecked | Checked | Hidden}] [-CopyVersionsOptionState <CopyMoveOptionState> {Disabled | Unchecked | Checked | Hidden}] [-CustomJSUrl <string>] [-DestinationSites <string[]>] [-EnableCopyAction <bool>] [-EnableExp

ortAction <bool>] [-EnableImportAction <bool>] [-EnableMoveAction <bool>] [-EnableTransactionLimits <bool>] [-EventReceiverClass <string>] [-IncludeFollowedSites <bool>] [-IncludeMySite <bool>] [-IncludeRecentDestinations <bool>] [-InjectEventPro

perties <bool>] [-KeepTemporaryFilesUntilCleanup <bool>] [-MaxAdminTransactionItemCount <int>] [-MaxAdminTransactionSize <int>] [-MaxListSubFoldersInTree <int>] [-MaxRecentDestinations <int>] [-MaxTransactionItemCount <int>] [-MaxTransactionSize

<int>] [-MoveExcludeProperties <string[]>] [-MovePermissionsOptionState <CopyMoveOptionState> {Disabled | Unchecked | Checked | Hidden}] [-MovePropertiesOptionState <CopyMoveOptionState> {Disabled | Unchecked | Checked | Hidden}] [-MoveVersionsOp

tionState <CopyMoveOptionState> {Disabled | Unchecked | Checked | Hidden}] [-RecentDestinationLinksRetentionDays <int>] [-ReportDetailedErrors <bool>] [-TemporaryFilesLocation <string>] [-UsePermissionLevels <bool>] [-UseRecycleBin <bool>] [-Warn

OnContentTypeLoss <bool>] [-WarnOnMetaDataLoss <bool>] [-WarnOnVersionHistoryLoss <bool>] [<CommonParameters>]

Parameters

Parameter

Required

Type

Description

EnableCopyAction

No

Boolean

Sets a Boolean value indicating whether to enable the Copy action in the UI.

EnableMoveAction

No

Boolean

Sets a Boolean value indicating whether to enable the Move action in the UI.

EnableExportAction

No

Boolean

Sets a Boolean value indicating whether to enable the Export action in the UI.

EnableImportAction

No

Boolean

Sets a Boolean value indicating whether to enable the Import action in the UI.

AllowUserSites

No

Boolean

Sets a Boolean value indicating whether users are allowed personalize the destination tree by adding other site collections / sub-sites.

IncludeRecentDestinations

No

Boolean

Sets a Boolean value indicating whether to include the most recent CopyMove destinations of the current user, in the destination tree.

IncludeFollowedSites

No

Boolean

Sets a Boolean value indicating whether to include the followed site collections of the current user, in the destination tree.

IncludeMySite

No

Boolean

Sets a Boolean value indicating whether to include the MySite site collection of the current user, in the destination tree.

EnableTransactionLimits

No

Boolean

Sets a Boolean value indicating whether CopyMove should enforce transaction limits.

InjectEventProperties

No

Boolean

Sets a Boolean value indicating whether CopyMove should inject the SPPCopyMoveEvent property for integration with custom event receivers.

KeepTemporaryFilesUntilCleanup

No

Boolean

Sets a Boolean value indicating whether CopyMove should not delete temporary files immediately after the completion of copy/move/import transactions.

ReportDetailedErrors

No

Boolean

Sets a Boolean value indicating whether CopyMove should report detailed errors in the UI on unexpected errors.

UsePermissionLevels

No

Boolean

Sets a Boolean value indicating whether to use CopyMove permission levels.

UseRecycleBin

No

Boolean

Sets a Boolean value indicating whether to keep a copy of moved documents in the recycle bin.

WarnOnContentTypeLoss

No

Boolean

Sets a Boolean value indicating whether CopyMove should issue warnings on loss of content type information.

WarnOnMetaDataLoss

No

Boolean

Sets a Boolean value indicating whether CopyMove should issue warnings on loss of metadata values.

WarnOnVersionHistoryLoss

No

Boolean

Sets a Boolean value indicating whether CopyMove should issue warnings on loss of version history.

CopyPermissionsOptionState

No

Enumeration

Sets the default state of the Include permissions check box in the Copy destination dialog. Possible values are:

•Checked: Check box is checked and visible.
•Unchecked: Check box is not checked and visible.
•Disabled: Check box is not checked and not visible.
•Hidden: Check box is checked and not visible.

CopyPropertiesOptionState

No

Enumeration

Sets the default state of the Include authors check box in the Copy destination dialog. Possible values are:

•Checked: Check box is checked and visible.
•Unchecked: Check box is not checked and visible.
•Disabled: Check box is not checked and not visible.
•Hidden: Check box is checked and not visible.

CopyVersionsOptionState

No

Enumeration

Sets the default state of the Include versions check box in the Copy destination dialog. Possible values are:

•Checked: Check box is checked and visible.
•Unchecked: Check box is not checked and visible.
•Disabled: Check box is not checked and not visible.
•Hidden: Check box is checked and not visible.

MovePermissionsOptionState

No

Integer

Sets the default state of the Include permissions check box in the Move destination dialog. Possible values are:

•Checked: Check box is checked and visible.
•Unchecked: Check box is not checked and visible.
•Disabled: Check box is not checked and not visible.
•Hidden: Check box is checked and not visible.

MovePropertiesOptionState

No

Integer

Sets the default state of the Include authors check box in the Move destination dialog. Possible values are:

•Checked: Check box is checked and visible.
•Unchecked: Check box is not checked and visible.
•Disabled: Check box is not checked and not visible.
•Hidden: Check box is checked and not visible.

MoveVersionsOptionState

No

Integer

Sets the default state of the Include versions check box in the Move destination dialog. Possible values are:

•Checked: Check box is checked and visible.
•Unchecked: Check box is not checked and visible.
•Disabled: Check box is not checked and not visible.
•Hidden: Check box is checked and not visible.

MaxAdminTransactionItemCount

No

Integer

Sets the maximum number of items that site collection administrators are allowed to process at a time. Specify a value between 1 and 5000.

MaxAdminTransactionSize

No

Integer

Sets the maximum size in MB, including versions, that site collection administrators are allowed to process at a time. Specify a value between 1 and 50000.

MaxListSubFoldersInTree

No

Integer

Sets the maximum number of sub-folders to query and show at any level in the destination tree. Specify a value between 100 and 50000.

MaxRecentDestinations

No

Integer

Sets the maximum number of recent destinations to store and show in the destination tree. Specify a value between 1 and 100.

MaxTransactionItemCount

No

Integer

Sets the maximum number of items that users are allowed to process at a time. Specify a value between 1 and 2500.

MaxTransactionSize

No

Integer

Sets the maximum size in MB, including versions, that users are allowed to process at a time. Specify a value between 1 and 10000.

RecentDestinationLinksRetentionDays

No

Integer

Sets the maximum number of days to track recently used destinations for users. Specify 0 to disable retention of recent user destination links.

TemporaryFilesLocation

No

String

Sets the file path to a local directory or a file share where CopyMove can store temporary files.

CustomJSUrl

No

String

Sets the URL address of a custom JavaScript file that CopyMove should load on all dialog pages.

EventReceiverClass

No

String

Sets the fully assembly qualified name of a .NET class that inherits and implements the SharePointProducts.CopyMove.CopyMoveEventReceiver class.

CompatibleLists

No

String Array

Array of strings with comma-separated list template ids. Each string must represent a list of compatible list templates that CopyMove should show alongside in the destination selection tree.

DestinationSites

No

String Array

Array of strings with the absolute URL addresses of SharePoint sites that should always show in the CopyMove destination tree for all users who have access.

CopyExcludeProperties

No

String Array

Array of strings with the internal names of SharePoint metadata properties and fields to exclude on all copy and import operations.

MoveExcludeProperties

No

String Array

Array of strings with the internal names of SharePoint metadata properties and fields to exclude on all move operations.

Examples

Change the temporary files location to a new folder on all servers in the SharePoint farm. The local security group WSS_WPG must be granted full access.

Set-CopyMoveFarmConfiguration -TemporaryFilesLocation "D:\CopyMove\Temp"

Change the temporary files location to a network share for all servers in the SharePoint farm. The IIS application pool identities of the SharePoint content Web Application must all be granted full access to the network share and the folder on the host server.

Set-CopyMoveFarmConfiguration -TemporaryFilesLocation "\\server\share"