Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

第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.52.0.Final-example-00007")
    },
    serviceInfo={
      @WidService(category = "myworkitem",
      description = "${description}",
      keywords = "",
      action = @WidAction(title = "Sample Title"),
      authinfo = @WidAuth(required = true,
      params = {"SampleParam", "SampleParamTwo"},
      paramsdescription = {"SampleParam", "SampleParamTwo"},
      referencesite = "referenceSiteURL"))
    }
)
Copy to Clipboard Toggle word wrap

Expand
表61.1 @Wid の説明
 説明

@Wid

WID ファイルを自動生成するトップレベルのアノテーション

widfile

Red Hat Process Automation Manager にデプロイするときに、カスタムタスク用に自動的に作成されるファイルの名前。

name

内部で使用されるカスタムタスク名。この名前は、Red Hat Process Automation Manager にデプロイするカスタムタスクで一意でなければなりません。

displayName

カスタムタスクの表示名。この名前は、Business Central のパレットに表示されます。

icon

src/main/resources/ から、現在のプロジェクトに配置されているアイコンへのパス。このアイコンは、Business Central のパレットに表示されます。アイコンを指定する場合は、16x16 ピクセルの PNG または GIF ファイルでなければなりません。この値を空白のままにして、デフォルトの Service Task アイコンを使用することができます。

description

カスタムタスクの説明

defaultHandler

カスタムタスクにリンクされたワークアイテムハンドラーの Java クラス。このエントリーの形式は、<language> : <class> です。Red Hat Process Automation Manager は、この属性の言語の値として mvel を使用することを推奨しますが、java を使用することも可能です。mvel に関する詳細は、MVEL Documentation を参照してください。

ドキュメント

カスタムタスクの説明が含まれる現在のプロジェクトの HTML ファイルへのパス

@WidParameter

@Wid の子アノテーション。Business Central GUI で生成される値、またはカスタムタスクのデータ入力として API 呼び出しが必要とする値を指定します。複数のパラメーターを指定できます。

name - パラメーター名

注記

この名前は、REST や SOAP などの転送メソッドの API 呼び出しで使用される可能性があるため、スペースや特殊文字を含めないでください。

required - パラメーターが、実行するカスタムタスクに必要かどうかを指定するブール値。

@WidResult

@Wid の子アノテーション。Business Central GUI で生成される値、またはカスタムタスクのデータ出力として API 呼び出しが必要とする値を指定します。複数の結果を指定できます。

name - 結果の名前

注記

この名前は、REST や SOAP などの転送メソッドの API 呼び出しで使用される可能性があるため、スペースや特殊文字を含めないでください。

@WidMavenDepends

@Wid の子アノテーション。ワークアイテムハンドラーが正しく機能するのに必要な Maven の依存関係を指定します。複数の依存関係を指定できます。

group - 依存関係の Maven グループ ID

artifact - 依存関係の Maven アーキタイプ ID

version - 依存関係の Maven バージョン番号

@WidService

@Wid の子アノテーション。サービスリポジトリーで生成される値を指定します。

category - ハンドラーを配置する UI パレットカテゴリー。この値は、@Wid アノテーションの category フィールドと一致する必要があります。

description - サービスリポジトリーに表示されるハンドラーの説明

keywords - ハンドラーに適用するキーワードのコンマ区切りの一覧。注: 現在、Business Central サービスリポジトリーでは使用されていません。

action - @WidAction オブジェクト。

authinfo - @WidAuth オブジェクト。オプション:

@WidAction

@WidService のオブジェクトです。

title - ハンドラーアクションのタイトル

description - ハンドラーアクションの説明。

@WidAuth

@WidService のオブジェクトです。

required - 認証が必要がどうかを判断するブール値

params - 必要な認証パラメーターが含まれるアレイ

paramsdescription - 各認証パラメーターの説明が含まれるアレイ

referencesite - ハンドラーのドキュメントの場所を指す URL。注: 現在、Business Central サービスリポジトリーでは使用されていません。

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat