ワークフロードキュメントクラスの作成

2024-06-27

クエリでテーブルフィールドを定義して、ワークフロー条件を作成します。一般的なシナリオでは、計算済フィールドはワークフローの動作を決定するために使用されます。たとえば、テーブル内のすべてのレコードの動的な販売合計をワークフロー条件として使用し、ステップを使用するかどうかを決定できます。ただし、クエリの制限としては、クエリ自体に計算済フィールドを定義できないことが挙げられます。このクエリ制限を克服するには、ワークフロードキュメントクラスを使用する必要があります。この記事では、ワークフロードキュメントクラスを作成する方法について説明します。

作成するワークフロードキュメントクラスは、アプリケーションエクスプローラーのクエリとパラメータメソッドという 2 つの方法で、条件のテーブルフィールドを定義します。クエリの名前を返すには、 WorkflowDocument クラスの getQueryName メソッドをオーバーライドする必要があります。必要に応じて、クラスの特定の署名を持つパラメータメソッドを追加して、計算済フィールドを追加することができます。ワークフロー条件の詳細については、ワークフロープロパティのコンフィギュレーションとワークフローでの条件付き意思決定のコンフィギュレーションを参照してください。

次の手順では、計算済フィールドのパラメータメソッドを含むワークフロードキュメントクラスを作成する方法について説明します。開始する前に、アクセスするデータを指定するクエリを作成する必要があります。ワークフロークエリの詳細については、ワークフロータイプのクエリの作成を参照してください。

ノート

ワークフロー ウィザードを使用してワークフロータイプを作成した場合は、ウィザードはワークフロードキュメントクラスを既に作成しています。

ワークフロードキュメントクラスの作成

新しいクエリを作成するには、次のいずれかのステップを実行します
- アプリケーションエクスプローラーで、 クラス ノードを展開します。 クラス ノードを右クリックし、 新しいクラス を選択します。クラスグループは、 クラス ノードの下に表示されます。新しいクラスを右クリックし、 名前変更 を選択して、ワークフロードキュメントクラスの名前を入力します。
- プロジェクト メニューの 新しい項目の追加 を選択します。 新しい項目の追加 ダイアログボックスで、 クラス を選択します。クラス名を入力し、作成を選択します。
新しいクラスを展開し、 classDeclaration を選択し、クラス宣言を右クリックして、次に編集を選択します。

クラス宣言に次のコードを入力します。

class <MyWorkflowDocumentClassName> extends WorkflowDocument
{
}

エディター ウィンドウを閉じ、はいを選択して変更を保存します。
新しいクラスを右クリックし、 オーバーライドメソッド をポイントして、次に getQueryName を選択します。 GetQueryName という名前のメソッドノードがワークフロードキュメントクラスノードの下に表示され、 エディター ウィンドウが表示されます。

ノート

オーバーライドする方法として getQueryName を選択してください。 WorkflowDocument.getQuery メソッドは、 WorkflowDocument.getQueryName メソッドによって返される文字列に基づいて、実際のクエリを取得するために内部的にのみ使用されます。
エディター ウィンドウで、次のコードをクエリメソッドに入力します。
```
QueryName getQueryName()
{
    return querystr(<MyWorkflowDocumentQueryName>);
}
```

ワークフロードキュメントクラスを作成した後、それをワークフロータイプにバインドできます。詳細については、ワークフロードキュメントクラスとワークフロータイプの関連付けを参照してください。

ワークフロードキュメントクラスに計算済フィールドを追加できるのは、次の条件を満たしている場合だけです。

parm <name> という名前にする必要があります。
CompanyId、 TableId、および RecId の各パラメータを定義する必要があります。
条件または通知メッセージを定義するフィールドの一覧に含まれる拡張データ型 (EDT) を返す必要があります。 EDTのラベルは、値を一意に識別する必要があります。

ワークフロードキュメントクラスへの計算済フィールドの追加

計算済フィールドを追加するワークフロードキュメントクラスで、クラスを右クリックして、 新しいメソッド を選択します。 クラス ノードの下に新しいメソッドノードが表示されます。
新しいメソッドノードを右クリックし、編集を選択します。

次の例に示す形式でコードを入力します。この例では、計算済フィールドを追加して仕訳帳の貸方金額の合計を決定する方法を示します。

public TotalJournalCreditAmount parmTotalJournalCreditAmount(CompanyId _companyId, TableId _tableId, RecId _recId)
{
    // The calculateAmounts method contains business and validation logic
    this.calculateAmounts(_companyId, _tableId, _recId);
    return totalJournalCreditAmount;
}

参照

ワークフロードキュメントクラスとワークフロータイプの関連付け