第61章 ワークアイテム定義
Red Hat Process Automation Manager では、Business Central に表示するデータフィールドを特定して、API 呼び出しを受け入れるのにワークアイテム定義 (WID) ファイルが必要です。WID ファイルで、Red Hat Process Automation Manager のユーザーの操作と、ワークアイテムハンドラーに渡されるデータの間をマッピングします。WID ファイルでは、カスタムタスク名、Business Central のパレットに表示されるカテゴリー、カスタムタスクの指定に使用するアイコン、カスタムタスクがマッピングするワークアイテムハンドラーなど、UI の情報も処理します。
Red Hat Process Automation Manager は、次の 2 つの方法で WID ファイルを作成できます。
-
ワークアイテムハンドラーをコード化する時に、
@Widアノテーションを使用する -
.widテキストファイルを作成します。たとえば、definitions-example.widです。
61.1. @Wid アノテーション
Maven アーキタイプを使用してワークアイテムハンドラープロジェクトを生成するときに @Wid アノテーションは自動的に作成されます。このアノテーションは、手動でも追加できます。
@Wid の例
@Wid(widfile="MyWorkItemDefinitions.wid",
name="MyWorkItemDefinitions",
displayName="MyWorkItemDefinitions",
icon="",
defaultHandler="mvel: new com.redhat.MyWorkItemWorkItemHandler()",
documentation = "myworkitem/index.html",
parameters={
@WidParameter(name="SampleParam", required = true),
@WidParameter(name="SampleParamTwo", required = true)
},
results={
@WidResult(name="SampleResult")
},
mavenDepends={
@WidMavenDepends(group="com.redhat",
artifact="myworkitem",
version="7.26.0.Final-example-00004")
},
serviceInfo={
@WidService(category = "myworkitem",
description = "${description}",
keywords = "",
action = @WidAction(title = "Sample Title"),
authinfo = @WidAuth(required = true,
params = {"SampleParam", "SampleParamTwo"},
paramsdescription = {"SampleParam", "SampleParamTwo"},
referencesite = "referenceSiteURL"))
}
)
表61.1 @Wid の説明
| 説明 | |
|---|---|
|
| WID ファイルを自動生成するトップレベルのアノテーション |
|
| Red Hat Process Automation Manager にデプロイするときに、カスタムタスク用に自動的に作成されるファイルの名前。 |
|
| 内部で使用されるカスタムタスク名。この名前は、Red Hat Process Automation Manager にデプロイするカスタムタスクで一意でなければなりません。 |
|
| カスタムタスクの表示名。この名前は、Business Central のパレットに表示されます。 |
|
|
|
|
| カスタムタスクの説明 |
|
|
カスタムタスクにリンクされたワークアイテムハンドラーの Java クラス。このエントリーの形式は、 |
|
| カスタムタスクの説明が含まれる現在のプロジェクトの HTML ファイルへのパス |
|
|
注記 この名前は、REST や SOAP などの転送メソッドの API 呼び出しで使用される可能性があるため、スペースや特殊文字を含めないでください。
|
|
|
注記 この名前は、REST や SOAP などの転送メソッドの API 呼び出しで使用される可能性があるため、スペースや特殊文字を含めないでください。
|
|
|
|
|
|
ハンドラーの目的を記述する
|
|
|
ハンドラーで必要な認証を定義する
|