チュートリアル: 関連付けフォームと開始フォームを持つワークフローの作成

[アーティクル]
08/09/2011

このチュートリアルでは、組み込まれたかたちで関連付けフォームと開始フォームを使用する基本的なシーケンシャルワークフローの作成方法について説明します。関連付けフォームと開始フォームは、それぞれ、SharePoint 管理者が初めてワークフローの関連付けを行うときと、ユーザーがワークフローを開始するときに、ワークフローにパラメーターが追加されるようにする ASPX フォームです。

このチュートリアルでは、次の要件を満たす経費明細書承認ワークフローを作成します。

管理者がワークフローをリストに関連付けようとすると、関連付けフォームが表示され、経費明細書の上限金額を入力するよう求められます。
従業員は各自の経費明細書を共有ドキュメントリストにアップロードしてワークフローを開始し、経費の合計をワークフローの開始フォームに入力します。
従業員の経費明細書の合計が、管理者によってあらかじめ定義された上限を超えている場合は、その従業員の上司が経費明細書を承認するためのタスクが作成されます。従業員の経費明細書の合計が経費の上限と等しい場合、またはそれよりも少ない場合は、自動承認メッセージがワークフローの履歴リストに書き込まれます。

このチュートリアルでは、次の作業について説明します。

SharePoint リスト定義シーケンシャルワークフロープロジェクトを Visual Studio で作成する。
ワークフロースケジュールを作成する。
ワークフローアクティビティのイベントを処理する。
ワークフローの関連付けフォームと開始フォームを作成する。
ワークフローを関連付ける。
ワークフローを手動で開始する。

注意

このチュートリアルではシーケンシャルワークフロープロジェクトを使用していますが、ステートマシンワークフローでも手順は同じです。

また、次の手順で参照している Visual Studio ユーザーインターフェイス要素の一部は、お使いのコンピューターでは名前または場所が異なる場合があります。これらの要素は、使用する Visual Studio のエディションとその設定によって決まります。詳細については、「設定の操作」を参照してください。

必須コンポーネント

このチュートリアルを実行するには、次のコンポーネントが必要です。

サポート対象エディションの Microsoft Windows および SharePoint。詳細については、「SharePoint ソリューションの開発要件」を参照してください。
Visual Studio 2010.

SharePoint シーケンシャルワークフロープロジェクトの作成

まず、Visual Studio でシーケンシャルワークフロープロジェクトを作成します。シーケンシャルワークフローは、最後のアクティビティが完了するまで順番に実行される一連の手順です。この手順では、SharePoint の共有ドキュメントリストに適用するシーケンシャルワークフローを作成します。ワークフローのウィザードを使用すると、サイト定義またはリスト定義のいずれかにワークフローを関連付けることができ、またワークフローを開始するタイミングを指定することができます。

SharePoint シーケンシャルワークフロープロジェクトを作成するには

[ファイル] メニューの [新規作成] をポイントし、[新しいプロジェクト] をクリックして、[新しいプロジェクト] ダイアログボックスを表示します。
[Visual C#] または [Visual Basic] の [SharePoint] ノードを展開して、[2010] をクリックします。
[テンプレート] ウィンドウでシーケンシャルワークフローを選択します。
[名前] ボックスに「ExpenseReport」と入力し、[OK] をクリックします。

SharePoint カスタマイズウィザードが表示されます。
[デバッグに使用するローカルサイト] ページで、[次へ] をクリックして、既定のサイトをそのまま使用します。

また、この段階で、ソリューションの信頼レベルがファームソリューション (ワークフロープロジェクトではこれ以外は選択できません) として設定されます。
[デバッグのワークフロー名の指定] ページで、既定の名前 (ExpenseReport - Workflow1) を受け入れます。既定のワークフローテンプレートの種類である [リストワークフロー] を受け入れます。 [次へ] をクリックします。
[デバッグセッション中に Visual Studio によってワークフローが自動的に関連付けられるようにする] ページで、ワークフローテンプレートを自動的に関連付けるためのチェックボックスがオンの場合は、チェックボックスをオフにします。

この手順によって、後で関連付けフォームを表示し、ワークフローを共有ドキュメントリストに手動で関連付けることができます。
[完了] をクリックします。

ワークフローへの関連付けフォームの追加

次に、SharePoint 管理者が初めてワークフローを経費明細書ドキュメントに関連付けるときに表示される .ASPX 形式の関連付けフォームを作成します。

ワークフローに関連付けフォームを追加するには

ソリューションエクスプローラー で [Workflow1] ノードをクリックします。
[プロジェクト] メニューの [新しい項目の追加] をクリックして、[新しい項目の追加] ダイアログボックスを表示します。
ダイアログボックスのツリービューで、(プロジェクトの言語に応じて) [Visual C#] または [Visual Basic] を展開し、[SharePoint] ノードを展開して、[2010] をクリックします。
テンプレートの一覧から [ワークフロー関連付けフォーム] を選択します。
[名前] ボックスに「ExpenseReportAssocForm.aspx」と入力します。
[追加] をクリックして、プロジェクトにフォームを追加します。

次に、開始フォームにコントロールとコードを追加して必要な機能を組み込みます。

開始フォームのコーディングをするには

初期化フォーム (ExpenseReportInitForm.aspx) で、ID="Main" の asp:Content 要素を特定します。

このコンテンツ要素の先頭行の直後に、次のコードを追加して、関連付けフォームで入力された承認する経費の上限 (AutoApproveLimit) を表示するラベルとテキストボックス、および経費の合計 (ExpenseTotal) を入力するよう求めるラベルとテキストボックスを作成します。

<asp:Label ID="lblAutoApproveLimit" Text="Auto Approval Limit:" runat="server" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<asp:TextBox ID="AutoApproveLimit" ReadOnly="true" runat="server" />
<br /><br />
<asp:Label ID="lblExpenseTotal" Text="Expense Total:" runat="server" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<asp:TextBox ID="ExpenseTotal" runat="server" />
<br /><br />

ソリューションエクスプローラーで ExpenseReportInitForm.aspx ファイルを展開して、その依存ファイルを表示します。
ExpenseReportInitForm.aspx ファイルを右クリックし、[コードの表示] を選択します。

Page_Load メソッドを次のコード例に置き換えます。

Protected Sub Page_Load(ByVal sender As Object, ByVal e As 
  EventArgs) Handles Me.Load
    InitializeParams()
    Me.AutoApproveLimit.Text = workflowList.WorkflowAssociations(New 
      Guid(associationGuid)).AssociationData
    ' Optionally, add code here to pre-populate your form fields.
End Sub

protected void Page_Load(object sender, EventArgs e)
{
    InitializeParams();
    this.AutoApproveLimit.Text = 
      workflowList.WorkflowAssociations[new 
      Guid(associationGuid)].AssociationData;
}

GetInitiationData メソッドを次のコード例に置き換えます。

' This method is called when the user clicks the button to start the workflow.
Private Function GetInitiationData() As String
    Return Me.ExpenseTotal.Text
    ' TODO: Return a string that contains the initiation data that 
    ' will be passed to the workflow. Typically, this is in XML 
    ' format.
    Return String.Empty
End Function

// This method is called when the user clicks the button to start the workflow.        
private string GetInitiationData()
{
    // TODO: Return a string that contains the initiation data that 
    // will be passed to the workflow. Typically, this is in XML 
    // format.
    return this.ExpenseTotal.Text;
}

ワークフローのカスタマイズ

次に、ワークフローをカスタマイズします。後で 2 つのフォームをワークフローに関連付けます。

ワークフローをカスタマイズするには

プロジェクトの [Workflow1] をダブルクリックして、ワークフローデザイナーにワークフローを表示します。
ツールボックスの [Windows Workflow v3.0] ノードを展開し、[IfElse] アクティビティを探します。
このアクティビティをデザイナーにドラッグし、ワークフローの [onWorkflowActivated1] アクティビティの直下にドロップしてワークフローに追加します。これで、IfElseActivity1 というアクティビティがデザイナーに作成されます。
ツールボックスの [SharePoint ワークフロー] ノードを展開し、[CreateTask] アクティビティを探します。
IfElseActivity1 内に 2 つある [ここにアクティビティをドロップしてください] 領域のいずれかに、このアクティビティをドラッグアンドドロップしてワークフローに追加します。
[プロパティ] ウィンドウで、CorrelationToken プロパティの taskToken のプロパティ値を入力します。
CorrelationToken プロパティの横に表示される正符号 () をクリックして展開します。
OwnerActivityName サブプロパティのドロップダウン矢印をクリックし、Workflow1 を選択します。
TaskId プロパティをクリックし、省略記号 () ボタンをクリックして、[プロパティのバインド] ダイアログボックスを表示します。
[新しいメンバーへのバインド] タブをクリックし、[フィールドの作成] を選択し、[OK] をクリックします。
TaskProperties プロパティをクリックし、省略記号 () ボタンをクリックして、[プロパティのバインド] ダイアログボックスを表示します。
[新しいメンバーへのバインド] タブをクリックし、[フィールドの作成] を選択し、[OK] をクリックします。
ツールボックスの [SharePoint ワークフロー] ノードを展開し、[LogToHistoryListActivity] アクティビティを探します。
IfElseActivity1 内にある、もう一方の [ここにアクティビティをドロップしてください] 領域に、このアクティビティをドラッグアンドドロップしてワークフローに追加します。

ワークフローへのコードの追加

次に、ワークフローにコードを追加して、必要な機能を実装します。

ワークフローにコードを追加するには

ワークフローデザイナーで [createTask1] アクティビティをダブルクリックして、MethodInvoking イベントに対する空のメソッドを生成します。

MethodInvoking メソッドを次のコードに置き換えます。

Private Sub createTask1_MethodInvoking(ByVal sender As 
  System.Object, ByVal e As System.EventArgs)
    createTask1_TaskId1 = Guid.NewGuid
    createTask1_TaskProperties1.AssignedTo = "somedomain\\someuser"
    createTask1_TaskProperties1.Description = "Please approve the 
      expense report"
    createTask1_TaskProperties1.Title = "Expense Report Approval 
      Needed"
End Sub

private void createTask1_MethodInvoking(object sender, EventArgs e)
{
    createTask1_TaskId1 = Guid.NewGuid();
    createTask1_TaskProperties1.AssignedTo = "somedomain\\someuser";
    createTask1_TaskProperties1.Description = "Please approve the 
      expense report";
    createTask1_TaskProperties1.Title = "Expense Report Approval 
      Needed";
}

注意

コード内の somedomain\\someuser の部分を、タスクの作成対象のドメインとユーザー名に置き換えます (例: "Office\\JoeSch")。テストの目的では、開発用のアカウントを使用するのが最も簡単です。

MethodInvoking メソッドの下に、次のコード例を追加します。

Private Sub checkApprovalNeeded(ByVal sender As Object, ByVal e As 
  ConditionalEventArgs)
    Dim approval As Boolean = False
    If (Convert.ToInt32(workflowProperties.InitiationData) > 
      Convert.ToInt32(workflowProperties.AssociationData)) Then
        approval = True
    End If
    e.Result = approval
End Sub

private void checkApprovalNeeded(object sender, ConditionalEventArgs 
  e)
{
    bool approval = false;
    if (Convert.ToInt32(workflowProperties.InitiationData) > 
      Convert.ToInt32(workflowProperties.AssociationData))
    {
        approval = true;
    }
    e.Result = approval;
}

ワークフローデザイナーで、[ifElseBranchActivity1] アクティビティをクリックします。
[プロパティ] ウィンドウで、[条件] プロパティのドロップダウン矢印をクリックし、Code Condition を選択します。
[条件] プロパティの横に表示される正符号 () をクリックして展開し、その値を checkApprovalNeeded に設定します。
ワークフローデザイナーで、[logToHistoryListActivity1] アクティビティを右クリックし、[ハンドラーの生成] を選択して、MethodInvoking イベントに対する空のメソッドを生成します。

MethodInvoking コードを次の内容に置き換えます。

Private Sub logToHistoryListActivity1_MethodInvoking(ByVal sender As 
  System.Object, ByVal e As System.EventArgs)
    Me.logToHistoryListActivity1.HistoryOutcome = ("Expense was auto 
      approved for " + workflowProperties.InitiationData)
End Sub

private void logToHistoryListActivity1_MethodInvoking(object sender, 
  EventArgs e)
{
    this.logToHistoryListActivity1.HistoryOutcome = "Expense was 
      auto approved for " + workflowProperties.InitiationData;
}

F5 キーを押して、プログラムをデバッグします。

これで、アプリケーションがコンパイルされ、パッケージ化されて配置されます。さらに、そのフィーチャーがアクティブ化され、IIS アプリケーションプールがリサイクルされて、ブラウザーが起動されます。このとき、ブラウザーには、[サイト URL] プロパティで指定されている場所が表示されます。

ドキュメントリストへのワークフローの関連付け

次に、SharePoint サイトの共有ドキュメント リストにワークフローを関連付けることによって、ワークフローの関連付けフォームを表示します。

ワークフローを関連付けるには

クイック起動バーの [共有ドキュメント] をクリックします。
[ライブラリツール] リボンタブの [ライブラリ] をクリックし、[ライブラリの設定] リボンボタンをクリックします。
[権限と管理] セクションの [ワークフロー設定] リンクをクリックし、[ワークフロー] ページの [ワークフローの追加] リンクをクリックします。
ワークフロー設定ページの一番上のリストから [ExpenseReport - Workflow1] テンプレートを選択します。
その次のフィールドに「ExpenseReportWorkflow」と入力して、[次へ] をクリックします。

これにより、ワークフローと共有ドキュメント リストが関連付けられ、ワークフローの関連付けフォームが表示されます。
[Auto Approval Limit] ボックスに「1200」と入力し、[ワークフローの関連付け] をクリックします。

ワークフローの開始

次に、共有ドキュメント リストのいずれかのドキュメントにワークフローを関連付けて、ワークフローの開始フォームを表示します。

ワークフローを開始するには

SharePoint ページの [ホーム] ボタンをクリックし、クイック起動バーの [共有ドキュメント] リンクをクリックして、SharePoint サイト上の共有ドキュメント リストを表示します。
ページ上部の [ライブラリツール] タブの [ドキュメント] リンクをクリックし、リボンの [ドキュメントのアップロード] ボタンをクリックして、共有ドキュメント リストに新しいドキュメントをアップロードします。
アップロードしたドキュメントをマウスでポイントすると、ドロップダウン矢印が表示されます。ドロップダウン矢印をクリックし、[ワークフロー] を選択します。
ExpenseReportWorkflow の横に表示されるイメージをクリックします。

これでワークフローの開始フォームが表示されます。 [Auto Approval Limit] ボックスに表示される値は、関連付けフォームで入力された値であるため読み取り専用です。
[Expense Total] ボックスに「1600」と入力し、[ワークフローの開始] をクリックします。

共有ドキュメント リストが再度表示されます。たった今ワークフローによって開始された項目に、ExpenseReportWorkflow という新しい列が追加され、列の値は [完了] になっています。
アップロードしたドキュメントの横に表示されるドロップダウン矢印をクリックし、[ワークフロー] をクリックして、ワークフローの状態ページを表示します。 [完了したワークフロー] 下の [完了] の値をクリックします。 [タスク] セクションにタスクが表示されます。
タスクのタイトルをクリックして、そのタスクの詳細を表示します。
共有ドキュメント リストに戻り、同じドキュメントまたは別のドキュメントを使用して再度ワークフローを開始します。
開始ページに、関連付けページで入力した値 (1200) と同じかそれよりも少ない金額を入力します。

この場合、タスクは作成されずに、履歴リストのエントリが作成されます。このエントリは、ワークフローの状態ページの [ワークフローの履歴] セクションに表示されます。履歴イベントの [結果] 列に表示されたメッセージに注目してください。 logToHistoryListActivity1.MethodInvoking イベントで入力したテキスト (自動承認された金額を含む) が出力されています。

次の手順

ワークフローテンプレートの作成方法の詳細については、以下のトピックを参照してください。

SharePoint ワークフローの詳細については、「Windows SharePoint Services のワークフロー」を参照してください。

参照

その他の技術情報

SharePoint ワークフローソリューションの作成

チュートリアル: ワークフローへのアプリケーションページの追加

次の方法で共有

チュートリアル: 関連付けフォームと開始フォームを持つワークフローの作成

必須コンポーネント

SharePoint シーケンシャルワークフロープロジェクトの作成

SharePoint シーケンシャルワークフロープロジェクトを作成するには

ワークフローへの関連付けフォームの追加

ワークフローに関連付けフォームを追加するには

関連付けフォームのデザインとコーディング

関連付けフォームのデザインとコーディングを行うには

ワークフローへの開始フォームの追加

開始フォームを作成するには

開始フォームのデザインとコーディング

開始フォームのコーディングをするには

ワークフローのカスタマイズ

ワークフローをカスタマイズするには

ワークフローへのコードの追加

ワークフローにコードを追加するには

ドキュメントリストへのワークフローの関連付け

ワークフローを関連付けるには

ワークフローの開始

ワークフローを開始するには

次の手順

参照

その他の技術情報

その他のリソース

次の方法で共有

チュートリアル: 関連付けフォームと開始フォームを持つワークフローの作成

必須コンポーネント

SharePoint シーケンシャル ワークフロー プロジェクトの作成

SharePoint シーケンシャル ワークフロー プロジェクトを作成するには

ワークフローへの関連付けフォームの追加

ワークフローに関連付けフォームを追加するには

関連付けフォームのデザインとコーディング

関連付けフォームのデザインとコーディングを行うには

ワークフローへの開始フォームの追加

開始フォームを作成するには

開始フォームのデザインとコーディング

開始フォームのコーディングをするには

ワークフローのカスタマイズ

ワークフローをカスタマイズするには

ワークフローへのコードの追加

ワークフローにコードを追加するには

ドキュメント リストへのワークフローの関連付け

ワークフローを関連付けるには

ワークフローの開始

ワークフローを開始するには

次の手順

参照

その他の技術情報

その他のリソース

SharePoint シーケンシャルワークフロープロジェクトの作成

SharePoint シーケンシャルワークフロープロジェクトを作成するには

ドキュメントリストへのワークフローの関連付け