Set-SPWorkflowConfig

リファレンス

モジュール:: sharepoint-server

適用対象:: SharePoint Server Subscription Edition

指定した Web アプリケーションのワークフロー設定を構成します。

構文

Set-SPWorkflowConfig
   [-SiteCollection] <SPSitePipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-DeclarativeWorkflowsEnabled <Boolean>]
   [-EmailNoPermissionParticipantsEnabled <Boolean>]
   [-SendDocumentToExternalParticipants <Boolean>]
   [-SingleWorkflowEpisodeTimeout <Int32>]
   [<CommonParameters>]

Set-SPWorkflowConfig
   [-WebApplication] <SPWebApplicationPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-DeclarativeWorkflowsEnabled <Boolean>]
   [-EmailNoPermissionParticipantsEnabled <Boolean>]
   [-SendDocumentToExternalParticipants <Boolean>]
   [-SingleWorkflowEpisodeTimeout <Int32>]
   [<CommonParameters>]

説明

このコマンドレットには、複数のパラメーターセットが含まれています。使用できるのは、1 つのパラメーターセットのパラメーターだけであり、異なるパラメーターセットのパラメーターを組み合わせることはできません。パラメーターセットの使用法に関する詳しい情報については、「コマンドレットのパラメーターセット」を参照してください。

コマンドレットを Set-SPWorkflowConfig 使用して、指定した Web アプリケーションのワークフロー設定を構成します。

Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンラインドキュメントをご覧ください。

例

------------------ 例 -----------------------

Set-SPWorkflowConfig -webapplication https://sitename DeclarativeWorkflowsEnabled $true -EmailNoPermissionParticipantsEnabled $true -SendDocumentToExternalParticipants $false

次の使用例は、指定した Web アプリケーションのワークフロー設定を設定して、宣言型ワークフローを有効にし、サイトへのアクセス許可を持たない参加者に電子メールを有効にし、電子メールメッセージを添付ファイルとして外部の参加者に送信する機能をオフにします。

戻り値はありません。コマンドレットを Get-SPWorkflowConfig 使用して値を表示します。イベント配信タイムアウトのファームレベルのワークフロー設定を設定し、しきい値とバッチサイズを延期するには、を使用 Set-SPFarmConfigします。

パラメーター

-AssignmentCollection

適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。

Global パラメーターが使用されている場合は、オブジェクトはすべてグローバルストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-DeclarativeWorkflowsEnabled

Web アプリケーション内で宣言型ワークフローの実行を許可するかどうかを設定します。

この型は、 True を表す 1 、 False の表す 0 のいずれかであることが必要です。

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-EmailNoPermissionParticipantsEnabled

ワークフローを実行中のサイトへの権限を持たないユーザーに、ワークフローからタスク電子メールメッセージを送信するかどうかを設定します。

この型は、 True を表す 1 、 False を表す 0 のいずれかであることが必要です。

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SendDocumentToExternalParticipants

サイトへのアクセス権を持たない参加者や Active Directory ドメインサービス (AD DS) 以外のリンクされたディレクトリに存在しない参加者に、ワークフローからドキュメントのコピーを電子メールの添付ファイルとして自動的に送信するかどうかを設定します。

この型は、 True を表す 1 、 False を表す 0 のいずれかであることが必要です。

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SingleWorkflowEpisodeTimeout

実行するワークフローに与えられる秒単位の時間。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SiteCollection

サイトコレクションの名前または URL を指定します。

この他に SiteCollection パラメーターと共に使用されるパラメーターは、 DeclarativeWorkflowsEnabled パラメーターのみです。これら以外のパラメーターは使用されません。

Type:	SPSitePipeBind
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-WebApplication

Web アプリケーションの名前または URL を指定します。

型は、WebApplication-1212 形式の有効な名前または GUID、またはフォームの URL である必要があります https://server_name/WebApplication-1212.

Type:	SPWebApplicationPipeBind
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition