メッセージマニフェスト
メッセージマニフェスト
ロボティックソリューションが成長するにつれて、問題を処理するために作成されるメッセージの数も増加します。 メッセージはオートメーションで定義され、ソリューションとプロジェクト全体に配信されます。 では、デベロッパーはオートメーション内で生成されたメッセージをどのように処理しますか。 Pega Robot Studio™は、デベロッパーがエンドユーザーへのメッセージングを管理できるようにするメッセージマニフェスト機能を提供します。
メッセージマニフェストとは次のようなものです。
- すべてのロボティックソリューション向けに標準化されたメッセージを作成するプラットフォームを提供する。
- 他部門とのメッセージの検討、編集、共有のために、メッセージをエクスポートする機能を提供する。
- プロジェクト内にて、メッセージ定義を一元的に所有する場所を提供する。
メッセージガイドライン
適切なエラーメッセージとはどのようなものですか。 エラーメッセージは分かりやすく、正確で、明示的です。
適切なエラーメッセージを作成するには、次の推奨ガイドラインに従ってください。
- エラーの発生場所に関するインジケータを含める。 これにより、エラーを含むオートメーションに関する情報がデベロッパーに提供されます。
- 障害点を特定するためのメッセージプレフィックスを提供する。
- メッセージにエラーコードまたは例外を指定する。
以下の画像では、Failed Jump Toには、メッセージ内の参照先のコードが含まれていて、これが表示されることでオートメーションのエラーを容易に見つけられます。
メッセージマニフェストの項目
メッセージマニフェストは、メッセージングガイドラインを満たすために、2つの項目（メッセージ定義とToolbox MessageManifestコンポーネント）を提供します。
メッセージ定義
メッセージストアは、Pega Robot Studioにより生成されたXMLファイルで、デベロッパーがプロジェクトプロパティの「Application」タブで作成したメッセージ定義がまとめられています。
メッセージ定義は6つの要素で構成されます。
| 要素 | 定義条項 |
|---|---|
| コード | メッセージごとにこの一意の英数字コードを使用して、メッセージを表示または取得します。 |
| キャプション | このプロパティを使用して、警告、情報、重要などのキャプションを含めたり、メッセージウィンドウに表示したりします。 |
| ボタン | このプロパティを使用して、「OK」などのボタンがメッセージに表示されるように定義します。 デベロッパーは、ボタンを組み合わせて、ユーザーの選択に基づいたオートメーションロジックを提供できます。 |
| アイコン | このプロパティを使用して、アイコンやグラフィックがメッセージに表示されるように指定します。 |
| デフォルトボタン | メッセージが表示されるときにフォーカスされるボタンを決定するために選択します。 選択したオプションは、ボタン要素で選択されたボタンの組み合わせに対応している必要があります。 |
| 本文 |
本文のテキストを文字制限なしで入力します。 テキストに変数を含めるには、中括弧内に0から始まる数値を挿入します。 変数はオートメーションで定義する必要があります。 例：Hello [0], the customer {1} will owe ${2} on {3}. このオートメーション化では、ユーザー名を0（ゼロ）、顧客名を1、未払金を2、請求書の支払期日を3と定義します。 |
MessageManifestコンポーネント
MessageManifestコンポーネントは、 Toolboxの「Advanced」カテゴリーにあり、メッセージマニフェスト機能を使用するには、プロジェクトのグローバルコンテナに追加する必要があります。
コンポーネントは以下を提供します。
- メッセージにアクセス、操作、表示する機能
- 文字列変数のメッセージ詳細のJSONシリアル化および逆シリアル化
このトピックは、下記のモジュールにも含まれています。
- 標準装備の機能 v1
トレーニングを実施中に問題が発生した場合は、Pega Academy Support FAQsをご確認ください。