Set-SPWorkflowConfig
指定した Web アプリケーションのワークフロー設定を構成します。
構文
SiteCollection
Set-SPWorkflowConfig
[-SiteCollection] <SPSitePipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-DeclarativeWorkflowsEnabled <Boolean>]
[-EmailNoPermissionParticipantsEnabled <Boolean>]
[-SendDocumentToExternalParticipants <Boolean>]
[-SingleWorkflowEpisodeTimeout <Int32>]
[<CommonParameters>]
WebApplication
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
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。
Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。
Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。
パラメーターのプロパティ
| 型: | SPAssignmentCollection |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DeclarativeWorkflowsEnabled
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
Web アプリケーション内で宣言型ワークフローの実行を許可するかどうかを設定します。
この型は、 True を表す 1 、 False の表す 0 のいずれかであることが必要です。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-EmailNoPermissionParticipantsEnabled
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
ワークフローを実行中のサイトへの権限を持たないユーザーに、ワークフローからタスク電子メール メッセージを送信するかどうかを設定します。
この型は、 True を表す 1 、 False を表す 0 のいずれかであることが必要です。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SendDocumentToExternalParticipants
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
サイトへのアクセス権を持たない参加者や Active Directory ドメイン サービス (AD DS) 以外のリンクされたディレクトリに存在しない参加者に、ワークフローからドキュメントのコピーを電子メールの添付ファイルとして自動的に送信するかどうかを設定します。
この型は、 True を表す 1 、 False を表す 0 のいずれかであることが必要です。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SingleWorkflowEpisodeTimeout
適用対象: SharePoint Server 2016、SharePoint Server 2019
実行するワークフローに与えられる秒単位の時間。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SiteCollection
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
サイト コレクションの名前または URL を指定します。
この他に SiteCollection パラメーターと共に使用されるパラメーターは、 DeclarativeWorkflowsEnabled パラメーターのみです。 これら以外のパラメーターは使用されません。
パラメーターのプロパティ
| 型: | SPSitePipeBind |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
SiteCollection
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WebApplication
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
Web アプリケーションの名前または URL を指定します。
型は、WebApplication-1212 形式の有効な名前または GUID、またはフォームの URL である必要があります https://server_name/WebApplication-1212.
パラメーターのプロパティ
| 型: | SPWebApplicationPipeBind |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
WebApplication
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。