入力チェックメッセージの設定

1. このページで伝える機能

入力エラーでは、対象項目だけでなく、期待する形式や上限、修正方法を伝えられます。チェックの定義とメッセージを識別コードで結び付け、文言をリソースとして管理します。

2. Wagby11で実現できること

連携先名称のバイト数エラーに、「Shift_JISで8バイト以内にしてください」と修正の目安を表示しています。画面と保存時の検証で同じ文言を使うため、共通のメッセージリソースへ設定します。

数量の範囲チェックも、「1から99までの整数」と具体的な条件を示せます。

項目の近くのメッセージとダイアログの内容を確認して入力を直せます。独自文言を用意するときは、画面の事前チェックと保存時に返るエラーの両方で、実際の表示を確認します。

3. AIへの指示例

最小限の指示例

入力エラーで、文字セットや許可される範囲が分かるメッセージを表示してください。

メッセージコードや文言の管理先をAIが既存構成から類推して補います。単に「不正です」ではなく、何をどの範囲に直すのかを伝える文章を指定します。

より詳細な指示例

InputCheck.externalNameのShift_JISで8バイト以内という制約と、quantityの1〜99という範囲制約に、安定したmessage_codeを付けてください。日本語文言を「連携先名称はShift_JISで8バイト以内にしてください。」「数量は1から99までの整数を入力してください。」とし、製品ルートのconfig/wagby-messages_ja.propertiesへ配置します。設計情報や生成ファイルに文言を直接埋め込まないでください。REST APIとWeb UIを再起動し、数量0について画面の事前チェックと同じ制約のAPI応答が同じ文言になることを確認してください。連携先名称のバイト数は保存時のサーバー側の結果も確認します。
既存のモデル・主キー・項目・データ・権限を保持し、必要なguide・referenceを確認してください。メニューと一般利用者向け操作マニュアルを更新し、設計情報の検証・コード生成・起動を行って、正常な入力とエラーになる入力を確認してください。

4. 編集されるAppSchemaの例

以下は関連する定義の抜粋です。構文を覚えなくても、許可したい値とエラーにする条件をAIへ伝えられます。

entity:
  attributes:
    - name: 連携先名称
      name_en: externalName
      type: string
      length: 100
      validation:
        constraints:
          - id: EXTERNAL_BYTES
            type: length
            unit: bytes
            charset: Shift_JIS
            max: 8
            severity: error
            message_code: error.manual.external.bytes
    - name: 数量
      name_en: quantity
      type: integer
      validation:
        constraints:
          - id: QUANTITY_RANGE
            type: range
            min: 1
            max: 99
            severity: error
            message_code: error.manual.quantity.range

制約のidとmessage_codeは安定した識別子として管理します。文言はAppSchemaとは別のメッセージリソースへ置きます。

画面とサーバーで共通に使う日本語文言は、製品ルートのconfig/wagby-messages_ja.propertiesへUTF-8で配置します。

error.manual.external.bytes=連携先名称はShift_JISで8バイト以内にしてください。
error.manual.quantity.range=数量は1から99までの整数を入力してください。

変更後はREST APIとWeb UIを再起動します。英語は_en、言語共通の標準文言は接尾辞なしのファイルへ定義できます。外部のメッセージファイルだけを変更した場合、再生成・再ビルドは不要です。

従来のアプリ内リソースへ置く場合、REST API側のsrc/main/resources/wagby-messages_ja.propertiesだけではWeb UIへ自動同期されません。共通の外部ファイルを使うと、文言を一か所で管理できます。生成されたメッセージファイルやOpenAPIは直接編集しません。

5. 参考資料

guide：入力チェックメッセージ

designer/docs/appschema/html/guide/04-validation/12-validation-messages.html

reference：validation（入力チェック定義）

designer/docs/appschema/html/reference/11-validation.html

国際化とユーザ設定

designer/docs/appschema/html/java/19_internationalization_user_preferences.html