本文へ移動
Wagby11
マニュアルのグループを選ぶ

WAGBY11 MANUAL / 31

設定する環境変数

開発・起動と実行時の機能で使う主な環境変数を、必要な条件と未設定時の動作から確認します。

最終更新日:

補足・参考資料の小目次へ

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

環境変数は、設計情報を変更せずに、起動する環境ごとの値を渡すために使います。このページでは、標準の起動手順で主に設定する変数を、用途、必要になる条件、未設定時の動作から確認できます。

標準のフォルダ構成でローカル開発を始める場合、以下の変数をすべて設定する必要はありません。Javaが利用できることを確認し、利用する機能や変更したい既定値に応じて設定します。開発中にメールなどを利用する場合は、実行時の設定も必要です。

2. Wagby11で実現できること

2.1 開発・起動で使う環境変数

環境変数設定する場面・対象未設定時
JAVA_HOME開発・ビルド・起動に使用するJDKを指定します。binではなくJDKのインストール先を指定します。標準のJava確認処理はPATH上のjavaを使用します。対応するJavaを利用できる必要があります。
WAGBY_REPOSITORY_DIR標準と異なる設計リポジトリを使うときに指定します。Designer、生成、Web UIなどで同じリポジトリを使います。Designerは自身のrepository、REST APIの生成やWeb UIは標準のdesigner/repositoryを参照します。
WAGBY_APPSCHEMA_REFERENCE_MODE設計ファイルの参照方式を指定します。通常は変更不要です。明示した参照だけを使う場合はexplicitにします。auto。規則に従ってモデルや関連定義を自動検出します。
WAGBY_START_TIMEOUTstartの起動待ち時間を正の整数の秒数で指定します。コンパイルや起動に時間がかかる場合に延長します。通常120秒。REST APIで初回・クリーン後などコンパイルが必要な場合と、先頭に--compileを指定した場合は900秒です。
WAGBY_STOP_TIMEOUTstopで通常の終了を待つ時間を正の整数の秒数で指定します。30秒。停止しない場合はエラーになり、通常のstopでは強制終了しません。
OPENAI_API_KEY
ANTHROPIC_API_KEY
ダミーデータ生成や帳票ツールのAI機能で、利用するプロバイダーのキーを設定します。キーは空です。利用するAI機能には対応するキーを用意します。両方を必ず設定するという意味ではありません。

参照モードはJavaシステムプロパティwagby.appschema.reference-mode、環境変数、既定値の順に決まります。参照モードを変更した場合は、その設定を使うプロセスを再起動します。

2.2 実行時の機能で使う環境変数

環境変数設定する場面・対象未設定時
WAGBY_CONFIG_DIR利用者設定を標準外の場所へ保存するときに、file:を付けない絶対パスを指定します。生成・REST API・Web UIなどへ同じ値を渡します。標準のconfig/を使用します。REST APIの標準読み込み先は../config/application.ymlです。ファイルがない場合は製品の既定設定を使用します。
WAGBY_ANONYMOUS_LOGIN_PASSWORDAppSchemaでanonymousログオンを有効にした場合、REST APIの起動前に共有アカウント用の値を設定します。anonymousログオンが無効なら不要です。有効なのに値がない場合は初期化できず、専用ログオンAPIは利用できません。REST APIの起動自体は継続します。
WAGBY_PUBLIC_URL利用者設定の同梱サンプルで、業務アプリケーションの公開URLを渡します。サンプルではhttp://localhost:18921です。
EKISPERT_ACCESS_KEY利用者設定の同梱サンプルで、駅すぱあと連携のアクセスキーを渡します。サンプルでは空です。連携を使う場合にキーを設定します。

WAGBY_PUBLIC_URLとEKISPERT_ACCESS_KEYは、config/application.ymlに同梱サンプルの環境変数参照を記述している場合に使われます。環境変数の名前を設定するだけで、任意の設定ファイルが書き換わるわけではありません。

DB接続先を切り替える場合は、接続設定だけでなく生成済みDDLや保存データの扱いも確認します。DB構造とマイグレーション、AWSでの設定はAWS配置の準備を参照してください。

2.3 SMTP接続と通知メール

SMTP接続はメール送信の接続先・認証を設定します。通知メールは通知機能の有効化・差出人・リンク先を設定します。SMTP接続を指定しただけで通知機能が有効になるわけではありません。

環境変数用途・必要になる条件未設定時
WAGBY_MAIL_HOSTメールを送信するSMTPサーバー。空。メールを送信する場合に接続先を用意します。
WAGBY_MAIL_PORTSMTPのポート番号。587
WAGBY_MAIL_USERNAME
WAGBY_MAIL_PASSWORD
SMTP認証で使用するユーザー名・パスワード。どちらも空。認証が必要な接続先では指定します。
WAGBY_MAIL_AUTHSMTP認証の有効・無効。true
WAGBY_MAIL_STARTTLS_ENABLE
WAGBY_MAIL_STARTTLS_REQUIRED
WAGBY_MAIL_SSL_ENABLE
SMTP接続の暗号化方式。接続先の仕様に合わせます。順にtrue、true、false
WAGBY_MAIL_CONNECTION_TIMEOUT
WAGBY_MAIL_TIMEOUT
WAGBY_MAIL_WRITE_TIMEOUT
SMTPの接続・読み取り・書き込みの待ち時間。単位はミリ秒です。順に5000、10000、10000
WAGBY_NOTIFICATION_ENABLED通知機能を使用する場合にtrueを指定します。false
WAGBY_NOTIFICATION_PUBLIC_BASE_URL通知に含めるリンクの基準URL。空。通知を利用するときに利用者からアクセスできるURLを指定します。
WAGBY_NOTIFICATION_LOCALE通知に使用するロケール。ja-JP
WAGBY_NOTIFICATION_MAIL_FROM
WAGBY_NOTIFICATION_MAIL_REPLY_TO
通知メールの差出人・返信先。どちらも空。差出人はメール送信の運用に合わせて指定します。

2.4 祝日・郵便番号データの場所

環境変数用途未設定時
WAGBY_HOMEREST APIが参照する付属データの基準フォルダ。Javaプロセスの作業ディレクトリ。標準のREST API起動ではrestapiです。
WAGBY_HOLIDAY_ICS祝日データのICSファイル。WAGBY_HOMEの基準フォルダにあるetc/holidays/JapanHolidays.ics
WAGBY_POSTAL_CODE_KEN_ALL住所の郵便番号データ。同じ基準フォルダのetc/postalcode/ken_all.zip
WAGBY_POSTAL_CODE_JIGYOSYO事業所の郵便番号データ。同じ基準フォルダのetc/postalcode/jigyosyo.zip
WAGBY_POSTAL_CODE_DICTIONARY郵便番号検索用の辞書ファイル。同じ基準フォルダのetc/postalcode/postalcode.bin

2.5 設定して起動する

環境変数は、対象のコマンドを実行する端末で設定します。起動済みのプロセスへ後から自動反映されるものではありません。次はREST APIの起動待ち時間だけを変更する例です。

macOS・Linux

WAGBY_START_TIMEOUT=1200 ./start.sh

Windows PowerShell

$env:WAGBY_START_TIMEOUT = '1200'
.\start.bat
# この端末で既定の動作へ戻す場合
Remove-Item Env:WAGBY_START_TIMEOUT

Windows コマンドプロンプト

set "WAGBY_START_TIMEOUT=1200"
start.bat
rem この端末で既定の動作へ戻す場合
set "WAGBY_START_TIMEOUT="

既定の動作へ戻す設定は、次に起動するプロセスへ適用されます。開発と実行環境で値を分けたい場合は、それぞれの起動元に設定します。パスワードやAPIキーの実値は、AppSchemaや共有する指示文へ書かず、管理している設定方法で渡してください。

3. 参考資料

  • 起動・停止と待ち時間:restapi/README.md
  • 利用者設定:config/README.md
  • 参照モードと自動補完:designer/docs/appschema/markdown/reference/05-modules.md
  • 帳票ツールのAI設定:reporting-tool/README.md