Commonweal - セットアップガイド

本書は、CommonwealをTALON環境にセットアップ・更新するための手順書です

1前提条件

TALON バージョン

項目	要件
TALON	Ver 5.1 以上
データベース	Oracle / PostgreSQL (引用符あり) / MySQL / SQL Server
ブラウザ	Chrome / Edge

必要権限

• 機能設計書を出力するには、対象機能の参照権限が必要です
• 機能説明タブで「管理者」が設定されている機能は、管理者と同じグループのユーザにしか検索結果に表示されません (TALON本体と同じ規則)
• （MySQLのみ）依存関係解析でストアドプロシージャ本体を読み取るため、MySQLではDB接続ユーザにグローバルSHOW_ROUTINE権限が必要です (ALL PRIVILEGES ON db.* では不足します)。権限がない場合、DEFINERが異なるプロシージャの本体が取得できず、依存関係に反映されません。
• セットアップ機能 (§3) はTALONのデータベース接続ユーザで管理テーブルの作成・列追加 (CREATE TABLE / ALTER TABLE) を行います。接続ユーザにテーブル作成権限があることを確認してください

外部サービス

本製品はTALON内で完結します。AIプロバイダー / 外部API / APIキーの準備は不要です。

HTTPS 推奨

設計書ファイルはサーバー上にファイルとして残さず、ブラウザへ直接受け渡してダウンロードする方式です。HTTP接続では「安全でないダウンロード」警告が表示されることがあるため、運用はHTTPSを推奨します。

製品モジュールの入手

製品モジュールはダウンロードページで配布しています (ダウンロードにはTALON構築支援サイトへのログインが必要です)。

Commonweal_{版数}.zipをダウンロードして解凍すると、次の2つが得られます。

Commonweal_{版数}.zip
├─ README.txt          … 版数と取込手順の概要
└─ TLN_FUNC_DOC_PKG/   … リポジトリ移送データ (次の§2で取り込みます)

TALON環境を用意せずに評価する場合は、同じページで配布しているDocker版 (Commonweal_Docker_{版数}.zip) が使えます。手順は§12を参照してください。

期間限定の共通ライセンスファイルも同じページで配布しています (§7)。

2リポジトリの取込

取込ファイル

§1でダウンロード・解凍したTLN_FUNC_DOC_PKGフォルダを、TALONのリポジトリ移送用フォルダへ配置して取り込みます。本リポジトリには以下が同梱されています。

リポジトリ移送機能については以下を参照してください。
［オプション］リポジトリ移送機能

機能

機能ID	機能名	用途
TLN_FUNC_DOC	Commonweal機能設計書出力	機能設計書を出力する画面 本機能のメイン画面
TLN_FUNC_DOC_SETUP	Commonwealセットアップ	本機能をセットアップする画面
TLN_FUNC_DOC_DOMAIN_LIST	Commonweal業務データ辞書一覧	業務データ辞書を一覧表示する画面
TLN_FUNC_DOC_DOMAIN_ALIAS_LIST	Commonweal業務データ辞書物理属性一覧	業務データ辞書の物理属性名を一覧表示する画面 (照会専用)
TLN_FUNC_DOC_DOMAIN_MAINTE	Commonweal業務データ辞書メンテナンス	業務データ辞書を作成・更新する画面 業務データ辞書一覧から起動する
TLN_FUNC_DOC_DOMAIN_SEARCH	Commonweal業務データ辞書検索	業務データ辞書メンテナンスのデータドメインコード欄から既存のデータドメインを探す検索子画面
TLN_FUNC_DOC_DOMAIN_EDIT	Commonweal業務データ辞書記入	業務データ辞書 記入 (現場部門向けの単票画面)
TLN_FUNC_DOC_DOMAIN_TASKS	Commonweal業務データ辞書宿題一覧	業務データ辞書 宿題一覧 (未記入のデータドメインのワークキュー)
TLN_FUNC_DOC_EDM	Commonweal_EDMメンテナンス	EDM(業務概念モデル)を管理する画面
TLN_FUNC_DOC_EDM_ATTR_SUGGEST	Commonweal_EDM属性サジェスト	業務データ辞書メンテナンスの EDM属性欄に候補を出す検索子画面
TLN_FUNC_DOC_EXCL_PICK	Commonweal照合除外登録	業務データ辞書照合除外 登録 (カタログ検索 + チェック一括登録)
TLN_FUNC_DOC_EXCL_MAINTE	Commonweal照合除外メンテナンス	業務データ辞書照合除外 メンテナンス

共通JSライブラリ

LIBRARY_CODE	用途
TLN_FUNC_DOC_COMMON	表示名辞書 / HTML・Markdown生成 / ER図生成 / ZIP化ロジック

汎用コード

識別コード	内容
TLN_FUNC_DOC_OUT_FLG	明細行「出力対象」チェックボックス用フラグ (運用での変更不要)
TLN_FUNC_DOC_APP_KBN	検索条件「アプリケーション区分」のリストボックス選択肢 (固定検索条件/フリー検索条件/検索子画面/検索ボタン無し)
TLN_FUNC_DOC_DOMAIN_KIND	辞書種別 (分類待ち/識別子/カテゴリ/数量/金額/日付/テキスト/その他)。業務に合わせて追加・変更可
TLN_FUNC_DOC_DB_NO	業務データ辞書照合除外2画面の検索条件「接続先」チェックボックス選択肢 (0:主DB / ALL:全接続先(串刺し) の2コードを同梱。複数DB接続を対象にする場合の追加手順は§5)

採番

採番識別コード	内容
TLN_FUNC_DOC_DOMAIN_KEY	ドメインコードの採番
TLN_FUNC_DOC_EDM_KEY	EDM コードの採番

取込手順

1. 解凍して得たTLN_FUNC_DOC_PKGフォルダを、TALON のインターフェースディレクトリ配下のREPOSITORYフォルダにフォルダごと配置 (例: {TALONインターフェースディレクトリ}/REPOSITORY/TLN_FUNC_DOC_PKG/)
2. TALON にログインし、TALON リポジトリ移送データ取込 画面を開く
3. 検索条件を入力して検索
   • リポジトリ識別名: TLN_FUNC_DOC_PKG
4. 検索結果を全選択し、「リポジトリ取込」ボタンをクリック
5. 「確定しました。」が表示されれば成功

3セットアップ機能の実行

リポジトリ取込後、必ずTLN_FUNC_DOC_SETUP(Commonwealセットアップ) を実行してください (何度実行しても問題ありません)。 リポジトリを取込み直した場合も、そのたびに再実行してください (§9バージョンアップ手順参照)。

1. TLN_FUNC_DOC_SETUP(Commonwealセットアップ) を開く
2. 「処理実行」ボタンをクリック
3. 「TLN_FUNC_DOC_SETUP 正常終了」が表示されれば成功。あわせて表示される「検出したDB: …」が実際の DB 種別と一致していることも確認してください

セットアップ機能は以下を自動で行います。

• 管理テーブルの作成: 以下のテーブルを作成します(存在しない場合のみ)。
  TLN_M_FUNC_DOMAIN (業務データ辞書)
  TLN_M_FUNC_DOMAIN_ATTR (物理属性名)
  TLN_M_FUNC_EDM (EDM ファイル管理)
  TLN_M_FUNC_DOMAIN_EXCL (業務データ辞書照合除外)
  TLN_M_FUNC_EXCL_PICK_WK (照合除外登録画面のワークテーブル)
  TLN_M_FUNC_EDM_ATTR_WK (EDMの中身のカタログ)
  TLN_M_FUNC_DOMAIN_TASKS_WK (宿題一覧の突き合わせ結果)
• 既存テーブルへの列追加 (不足している場合のみ): 複数プロジェクト対応のPROJECT_ID列をEDM / ドメイン関連テーブルに追加します。新規作成時は主キーの直後に配置されます。既存環境への追加時も、Oracle (12c以降)・MySQLでは主キー直後へ自動的に並べ直します。SQL Server・PostgreSQL (および12cより前のOracle) では末尾に追加されますが、動作に影響はありません。
• 旧バージョンからの更新時のマイグレーション: 本機能のバージョンアップに伴いテーブルのスキーマに変更がある場合は、変更内容に合わせてテーブル定義を自動で更新します(該当する場合のみ実行され、何度実行しても安全です)。
• 汎用コードの初期登録:
  ・TLN_FUNC_DOC_DEPT：ユーザマスタの部門コードから登録します (既存キーは上書きしません)。
  ・TLN_FUNC_DOC_PROJECT：未登録の場合のみ識別コード維持行PJ00(表示名が空のため画面には出ません) を1行だけ登録します。
• DB 種別に応じた機能設定の変換: 接続DBを自動検出し、DB種別に応じて各種機能を更新します。

画面表示言語の切り替え(日本語/英語)

セットアップ画面には「処理実行」のほかに「日本語に変換」「英語に変換」の2つのボタンがあります。「英語に変換」を押すと、本製品の画面の表示文言が英語に書き換わります。TALONの標準メッセージに埋め込まれる機能名・ブロックタイトルも英語になります。

• 言語は環境(データベース)単位で切り替わります。利用者ごとの切り替えではありません
• 変換は何度実行しても安全です。なお利用者が独自に変更した表示名は書き換えずスキップします
• 「日本語に変換」で完全に元へ戻ります
• リポジトリを取込み直すと日本語に戻ります。英語で運用している環境では、取込のたびに再度「英語に変換」を押してください
• TALON標準部分のボタン・メッセージの言語は、従来どおりTALON自体の多言語機能(利用者のブラウザ言語等)で決まります。設計書出力(HTML/Markdown)の言語も従来どおり利用者ごとの判定で、この設定の影響を受けません
• メニューの表示名も変換の対象です (§6で登録済みの場合)。ただしメニューはリポジトリ取込で日本語に戻らないため、取込後の再変換では対象外 (スキップ) になります。英語で運用する環境では「英語に変換」→「メニュー登録」の順に押してください (メニューは押した時点の言語で登録されるため)

メニュー登録ボタン

セットアップ画面には「メニュー登録」ボタンもあります。本製品の 8 画面を TALON のメニューへ一括登録するボタンです。登録内容は §6 メニュー登録 を参照してください。

• 何度押しても安全です(既にメニューにある機能はスキップします)
• 登録したメニューは再ログイン後に表示されます
• 利用者がメニュー上で移した項目・改名した項目はそのままにします(別のフォルダへ移した機能を元の場所に戻したりしません)。ただし製品が出荷時に付けた表示名のままの項目は、製品側で画面名を変更したときに新しい名前へ追随します(名前が出荷時のものと完全に一致する項目だけが対象で、利用者が付けた名前は書き換えません)
• メニューからの削除は行いません (撤去は§10 アンインストール)

4テーブル更新権限の付与

業務データ辞書メンテナンス (TLN_FUNC_DOC_DOMAIN_MAINTE)・EDM 管理 (TLN_FUNC_DOC_EDM)・照合除外メンテナンス (TLN_FUNC_DOC_EXCL_MAINTE) は管理テーブルを更新するため、利用するユーザのグループにテーブル更新権限が必要です。付与しない場合、画面を開いた時に権限エラーが発生します。

1. TALON メニュー → 機能構築 → テーブル更新権限設定 を開く
2. 以下4テーブルについて、利用するグループの更新権限をONにする
   • TLN_M_FUNC_DOMAIN
   • TLN_M_FUNC_DOMAIN_ATTR
   • TLN_M_FUNC_EDM
   • TLN_M_FUNC_DOMAIN_EXCL
3. 確定する

5汎用コードの追加設定 (複数DB接続を使う場合のみ)

複数DB接続を使用する場合、汎用コードマスタTLN_FUNC_DOC_DB_NOの追加設定を行います。

汎用コードマスタの登録・変更の基本操作については以下を参照してください。
8.1. TALON汎用マスタ変更

本設定を行うことにより、照合除外の2画面 (TLN_FUNC_DOC_EXCL_PICK / TLN_FUNC_DOC_EXCL_MAINTE) の検索条件「接続先」に、指定した複数DB接続の選択肢が追加されます。なお、製品同梱のコードは 0:主DB と ALL:全接続先(串刺し) の2つのみです。

複数DB接続 (接続先1..15) を照合除外の対象にする場合は、TALON の汎用コードマスタメンテナンスで識別コード TLN_FUNC_DOC_DB_NO にコードを追加してください:

項目	設定値	設定例
キー値 (KEY_CODE)	複数DBの接続先番号	1
識別名称 (SIKIBETU_NM)	当該識別コードの名称（任意）	設計書_DB接続先
表示値 (DSP1)	チェックボックスに表示されるラベル	販売管理DB
表示２ (DSP2)	英語表示を使う場合の英語ラベル (任意)
ソート順 (DSP_SORT1)	接続先番号 (並び順)	1

追加したコードは両画面のチェックボックスと、メンテナンス画面の明細「接続先」リストの選択肢に反映されます。

6メニュー登録

TALONのメニュー登録はリポジトリ移送の対象外のため、取込だけでは本製品の画面がメニューに出ません。セットアップ画面の「メニュー登録」ボタンで一括登録するか、TALON標準のメニュー設定機能で手動登録してください。

ボタンで一括登録する (推奨)

1. TLN_FUNC_DOC_SETUP(Commonwealセットアップ) 画面を開く
2. 「メニュー登録」ボタンをクリック
3. 「メニューを登録しました (新規 N 件 / 既に登録済み M 件 / 対象 8 件)」が表示されれば成功
4. いったんログアウトし、ログインし直す (メニューはログイン時に組み立てられるため、再ログインするまで画面に反映されません)

ボタンは以下を行います (何度押しても安全な冪等処理です)。

• メニューフォルダCommonwealを作る (無い場合のみ)
• そのフォルダを、TLN_FUNC_DOCの機能実行権限を持つユーザグループに紐付ける (無い場合のみ)
• 下表の「ボタンでの登録」が〇の8機能をフォルダ配下に登録する (メニューに無い機能のみ)

登録される機能は次のとおりです。メニューの表示名は機能名から製品名 (Commonweal) を取り除いたものです (例 Commonweal機能設計書出力 → 「機能設計書出力」)。

機能 ID	機能名 (画面表示)	ボタンでの登録
TLN_FUNC_DOC	Commonweal機能設計書出力	〇
TLN_FUNC_DOC_DOMAIN_LIST	Commonweal業務データ辞書一覧	〇
TLN_FUNC_DOC_DOMAIN_ALIAS_LIST	Commonweal業務データ辞書物理属性一覧	〇
TLN_FUNC_DOC_DOMAIN_MAINTE	Commonweal業務データ辞書メンテナンス	〇
TLN_FUNC_DOC_DOMAIN_TASKS	Commonweal業務データ辞書宿題一覧	〇
TLN_FUNC_DOC_DOMAIN_EDIT	Commonweal業務データ辞書記入
TLN_FUNC_DOC_DOMAIN_SEARCH	Commonweal業務データ辞書検索
TLN_FUNC_DOC_EDM	Commonweal_EDMメンテナンス	〇
TLN_FUNC_DOC_EDM_ATTR_SUGGEST	Commonweal_EDM属性サジェスト
TLN_FUNC_DOC_EXCL_PICK	Commonweal照合除外登録	〇
TLN_FUNC_DOC_EXCL_MAINTE	Commonweal照合除外メンテナンス	〇
TLN_FUNC_DOC_SETUP	Commonwealセットアップ

登録の約束:

• 既にメニューにある機能はスキップします。別のフォルダへ移した項目もそのままにします (利用者の配置を尊重するため、フォルダを問わず「その機能IDがメニューにあるか」だけを見ます)
• 出荷時の表示名から改名された画面には追随します。バージョンアップで画面名が変わったときは、登録済みの項目の表示名が出荷時の名前と完全に一致する場合だけ新しい名前へ書き換えます (利用者が独自に付けた名前はそのままです)。完了メッセージの「改名 N 件」がその件数です
• メニューからの削除は行いません (撤去は§10 アンインストール)
• 表示順は850番から採りますが、他機能が使っている番号は避けて空き番号に登録します
• 表示名は現在の画面表示言語 (§3) に合わせて日本語 / 英語のどちらかで入ります。英語で運用する環境では「英語に変換」を先に押してから「メニュー登録」を押してください
• 登録先のフォルダ・ユーザグループを変えたい場合や、既存の業務メニューへ組み込みたい場合は、ボタンで登録したあとにTALON標準のメニュー設定機能で移動してください (再度ボタンを押しても元に戻されません)

手動で登録する場合

TALON標準のメニュー設定機能でも登録できます (独自のメニュー階層に配置したい場合など)。画面のURLは次の形式です。

TALON/APPLICATION/GENERALFREE/GENERALFREE.xhtml?PARAM_FUNC_ID={機能ID}

7ライセンス (販売プラン) の配置

本製品には 無償版 / 物理DB連携版 / 全機能版 の3つの販売プランがあります。プランはライセンスファイルで決まります。

プラン	ライセンス	出力される成果物
① 無償版	不要	機能設計書 + 機能一覧 + 機能依存ツリー + 差分設計書 (Compare.html) + AI 向け Markdown (meta/)
② 物理DB連携版 (有償)	要	① + 物理DB設計書 (ER図 / DDL) + 機能×物理マトリクス
③ 全機能版 (有償)	要	② + 業務データ辞書・業務概念モデル (EDM)・全マトリクス

• ① 無償版はライセンス不要です。何も配置しなければ ① で動作します。

• ② / ③ は販売元発行のライセンスファイルが必要です。受領したライセンスファイルの内容を丸ごと、次のパスに commonweal_license.key として保存します:

  {Payara}/glassfish/domains/{ドメイン名}/lib/classes/commonweal_license.key
  例: /opt/payara/appserver/glassfish/domains/domain1/lib/classes/commonweal_license.key

  ※ talonJdbc.properties と同じフォルダです。TALONの再起動は不要です。

• 期間限定の共通ライセンス (2026-12-31まで有効・③全機能版) はダウンロードページから入手できます。配置場所・確認方法は有償ライセンスと同じです。
• ライセンスファイルが存在しない場合や期限切れ、無効の場合は①無償版で動作します。
• ライセンスファイルを開くと、先頭にプラン・顧客・有効期限が記載されています。
• 適用中のプランは画面には表示されません。確認は (a) 出力したZIPにer-diagram.html(②以上) / EDM.html(③) が含まれるか、(b) Payaraサーバーログの[TFC] ライセンス: ... edition=Nの値、のいずれかで行います。
• プラン別に出力される成果物の詳細な一覧はトップページの「プランと機能範囲」を参照してください。ライセンスの発行・更新の問合せ先は「サポート」を参照してください。

8動作確認

確認項目

No	確認内容	手順
1	画面表示	機能設計書出力画面が表示されること
2	機能 ID 検索	検索条件に機能 ID を入力し検索結果が表示されること
3	「出力対象」チェック	一覧の「出力対象」列のチェックボックスで複数行を選択できること
4	設計書出力ボタン	「設計書出力」ボタン (TALON 標準の確定ボタン) 押下後、Commonweal_design_yyyymmdd_hhmmss.zip がブラウザにダウンロードされること
5	ZIP 内容	ZIP を解凍し、index.html と機能ごとの FuncDoc_{機能ID}_{機能名}.html、meta/ 配下の Markdown が含まれること
6	HTML 表示	ブラウザで HTML を開き、画面ビジュアル・依存関係・コードブック・全設定のタブが表示されること
7	ER 図	er-diagram.html にテーブル定義が表示されること (er-diagram.a5er / .sql も同梱)。※本項目はライセンス配置済み (② 物理DB連携版 / ③ 全機能版) の場合のみ。① 無償版では ER 図は出力されません (§7参照)
8	0件選択時	何もチェックせず「設計書出力」を押すと「出力対象が選択されていません。」のエラーメッセージが表示されること
9	権限設定	業務データ辞書一覧 / メンテナンス・EDM・照合除外メンテナンスの各画面が権限エラー (CMN_E0108) なく開けること (該当機能を利用する場合)
10	検索子画面	業務データ辞書メンテナンスのデータドメインコード欄の検索ボタンを押すと業務データ辞書検索が開き、登録済みのデータドメインが一覧されること。コード / 名称の部分一致で絞り込め、行の[選択]で子画面が閉じて呼出元の検索条件にコードが入ること (該当機能を利用する場合)

正常に ZIP がダウンロードされない場合は11. トラブルシューティングを参照してください。

9バージョンアップ手順

既に本製品を導入済みの環境を新しいバージョンへ更新する手順です。

1. 配置済みの {TALONインターフェースディレクトリ}/REPOSITORY/TLN_FUNC_DOC_PKG/ を、新版のリポジトリファイルでフォルダごと置き換える
2. §2の取込手順どおり再取込する
3. §3のセットアップ機能を必ず再実行する
4. §8の動作確認を行う

維持されるもの / 再実行が必要なもの

対象	バージョンアップ時
業務データ辞書・EDM・照合除外の登録データ	保持されます。取込対象は機能設定・共通 JS ライブラリ・汎用CD・採番のみで、登録データを保持する管理テーブルは取込対象に含まれません
テーブル更新権限 (§4)・メニュー登録 (§6)・ライセンスファイル (§7)	再設定不要
セットアップ機能の実行 (§3)	再取込のたびに再実行が必要

10アンインストール

本製品を撤去する場合は、導入手順の逆順で以下を行います。

1. メニュー登録の削除 — §6 で登録した機能を、TALON標準のメニュー設定機能から手動で削除してください (製品側に削除ボタンはありません)。systemCOMMONWEALフォルダを他の用途にも使っていない場合は、フォルダごと削除してかまいません。削除内容は再ログインで反映されます。
2. 登録物の削除 — TALON 標準のメンテナンス機能で以下を削除する
   • 機能設定: TLN_FUNC_DOC で始まる12機能 (§2 の一覧)
   • 汎用CD: 識別コード TLN_FUNC_DOC_OUT_FLG / TLN_FUNC_DOC_APP_KBN / TLN_FUNC_DOC_DOMAIN_KIND / TLN_FUNC_DOC_DB_NO と、セットアップ機能が作成する TLN_FUNC_DOC_DEPT (責任部門)・TLN_FUNC_DOC_PROJECT、画面言語を切り替えた環境では TLN_FUNC_DOC_LANGUAGE
   • 採番: TLN_FUNC_DOC_DOMAIN_KEY / TLN_FUNC_DOC_EDM_KEY
   • JS/CSS ライブラリ: TLN_FUNC_DOC_COMMON
3. テーブル更新権限の解除 — §4 で付与した4テーブルの更新権限を OFF にする
4. 管理テーブルの扱い — セットアップ機能が作成した管理テーブルは自動では削除されません
   • TLN_M_FUNC_DOMAIN / TLN_M_FUNC_DOMAIN_ATTR / TLN_M_FUNC_EDM / TLN_M_FUNC_DOMAIN_EXCL は、利用者が登録した業務データ辞書・EDM・照合除外のデータ (資産) を保持しています。残置するか、バックアップを取得してから DROP するかを選択してください
   • TLN_M_FUNC_EXCL_PICK_WK / TLN_M_FUNC_EDM_ATTR_WK / TLN_M_FUNC_DOMAIN_TASKS_WK は一時データのみのため、そのまま DROP できます
   • PostgreSQL / MySQL (Windows) ではテーブル名が小文字 (tln_m_func_domain 等) で作成されています
5. ライセンスファイルの削除 — 配置していた場合は commonweal_license.key を削除する (§7 の配置パス)

出力済みの設計書ZIPは製品から独立したHTML / Markdownのため、アンインストール後もそのまま閲覧できます。

11トラブルシューティング

「設計書出力」ボタンを押しても ZIP がダウンロードされない

ZIP は処理完了メッセージと連動してブラウザがダウンロードを開始する方式です。以下を順に確認してください。

1. メッセージ表示が抑制されていないか
   — TALON側の設定で処理完了メッセージが表示されない場合、ダウンロードが開始されません。
2. ブラウザコンソールでTFC_DL download failedエラーが出ていないか
   — ポップアップブロッカー / ダウンロード制限の可能性があります。設定状況を確認してください。
3. HTTPで運用していないか
   — Chrome 等はHTTP経由のダウンロードに警告ダイアログを出します。HTTPSで運用してください。
4. Payaraサーバーログの [TFC] プレフィックス行
   — [TFC] targetFuncIds=... が出力されていれば サーバ側ロジックは到達しています。出ていない場合はリポジトリ取込のやり直しを検討してください。

業務データ辞書メンテナンス / EDM画面で権限エラーが発生する

管理テーブルの更新権限が未付与です。4. テーブル更新権限の付与を実施してください。

権限を付与済みでも発生する場合、PostgreSQL / MySQL (Windows) ではセットアップ機能の実行漏れが原因のことがあります。リポジトリを取込み直した後は3. セットアップ機能の実行を必ず再実行してください。

PostgreSQL / MySQL (Windows) で画面が正しく動作しない / 検索がエラーになる

TLN_FUNC_DOC_SETUPの実行漏れが疑われます。3. セットアップ機能の実行を実施してください。

照合除外の一括登録画面で検索しても結果が0件になる

本製品の各機能をTALONの機能設定画面で編集・再保存すると、一部画面の内部的な検索条件設定が失われ、業務データ辞書照合除外の一括登録画面 (TLN_FUNC_DOC_EXCL_PICK) などで検索結果が表示されなくなることがあります。

復旧するには、リポジトリを再取込し (2. リポジトリの取込)、セットアップ機能を再実行してください (3. セットアップ機能の実行)。※再取込により機能設定は同梱の初期状態に戻るため、独自にカスタマイズした設定は失われます。本製品の機能設定はTALONの機能設定画面で編集・再保存しないことを推奨します。

「JS が見つかりません」「ライブラリが見つかりません」

共通 JS ライブラリTLN_FUNC_DOC_COMMONがリポジトリ取込で登録されていない可能性があります。リポジトリ取込画面でTLN_FUNC_DOC_COMMONの登録有無を確認してください。

「対象機能のデータが取得できませんでした。」が表示される

チェックした機能の機能設定データが取得できなかった状態です。対象機能IDのTALON機能設定がDB上に存在するか、ログイン中ユーザーに対象機能の参照権限があるかをご確認ください。

ストアドプロシージャの本体が依存関係に出ない (MySQL)

TALON 接続ユーザにグローバルSHOW_ROUTINE権限を付与してください (1. 前提条件参照)。

出力内容の読み方に関するトラブル

「ブロック番号が他のドキュメントと1ずれる」「設定項目名がコード値 (例: BUTTON_NEXT_3) のまま表示される」など、出力された設計書の読み方に関するトラブルは、ユーザーマニュアルの「困ったとき」を参照してください。

12Docker 版で導入する (自己完結環境)

本章は、TALON本体とCommonwealをまとめて1台の PC / サーバー上に自己完結で立ち上げる Docker Compose 版の手順です。なお本手順はDocker Desktopがインストールされていることを前提に記載します。未導入の場合は事前にインストールしてください。

全体の流れ

1. ダウンロードページで配布しているCommonweal_Docker_{版数}.zipを解凍し、commonweal-postgres フォルダを PC に配置する
2. Talon.war を配置する
3. ライセンスファイルを配置する
4. 起動する (docker compose up -d --build を実行するだけ)
5. 起動が完了するまで待ち、ブラウザで開く

事前に用意するもの

用意するもの	入手方法
Commonweal Docker 版の配布ZIP (Commonweal_Docker_{版数}.zip)	TALON構築支援サイトから入手
Talon.war	TALON構築支援サイトから入手
Talon.crypt (TALON 本体のライセンス)	配布元から入手
commonweal_license.key (Commonweal 有償プランのライセンス)	本製品の販売元が発行

手順1: 配布ZIPを解凍して配置する

配布元から入手したZIP (Commonweal_Docker_{版数}.zip) を解凍すると commonweal-postgres フォルダが現れます。これを PC の分かりやすい場所に配置します (パスに日本語や空白を含めないことを推奨します)。

例 (Windows): C:\docker\commonweal-postgres\
例 (Mac/Linux): ~/docker/commonweal-postgres/

配置後、フォルダの中身が次のようになっていることを確認してください。

commonweal-postgres/
├── docker-compose.yml
├── Dockerfile.payara
├── README.md
├── scripts/
├── config/
│   ├── db/postgresql/
│   ├── lib-classes/        ← 手順3でライセンスファイルを置く場所
│   ├── talon/
│   └── docroot/
└── war/
    └── README.md            ← 手順2で Talon.war を置く場所

手順2: Talon.war を配置する

Talon.warを、commonweal-postgresフォルダ直下のwarフォルダにコピーします。ファイル名は必ずTalon.warのままにしてください。

commonweal-postgres/
└── war/
    └── Talon.war   ← ここにコピーする

手順3: ライセンスファイルを配置する

commonweal-postgres/config/lib-classes/フォルダに、以下のファイルをコピーします。

commonweal-postgres/
└── config/
    └── lib-classes/
        ├── Talon.crypt                    ← TALON 本体のライセンス (必須)
        └── commonweal_license.key       ← Commonweal 有償プランのライセンス (任意)

• Talon.crypt はTALON本体のライセンスファイルです。配置しないまま起動すると、ブラウザでログインした際に期限切れのエラーが表示されます。
• commonweal_license.keyはCommonwealの②物理DB連携版・③全機能版を使う場合のみ必要です。用意できない場合はスキップして構いません。未配置のまま起動すると自動的に①無償版として動作し、後から追加することもできます。

手順4: 起動する

commonweal-postgresに移動後、次のコマンドを実行します。

docker compose up -d --build

• 初回はベースイメージ等のダウンロードのため、インターネット接続が必要です

手順5: 起動が完了したことを確認する

手順4のコマンド実行完了後、バックグラウンドにて「データベースの初期化 → TALONのデプロイ → Commonwealのリポジトリ取込・セットアップ」が自動的に進みます。次のコマンドでログの確認が可能です。

docker compose logs -f talon

次の行が表示されたら準備完了です。

[COMMONWEAL] Commonweal module setup complete.

表示されたらCtrl + Cでログの表示を終了します (コンテナ自体は動き続けるので停止操作ではありません)。なお、初回は全体で10分近くかかる場合があります。

コンテナの状態は次のコマンドでも確認できます。両方ともUp (またはhealthy) と表示されていれば正常です。

docker compose ps

コンテナ名	役割	正常時の状態
commonweal-postgres-db	PostgreSQL	Up (healthy)
commonweal-postgres-payara	TALON (Payara)	Up

手順6: ブラウザでアクセスする

ブラウザで次のURLを開きます。demo / demoでログインが可能です。

http://localhost:8080/Talon/

ログイン後、メインメニューに 「Commonweal」 カテゴリが表示され、「機能設計書出力」など8機能が登録されていれば導入成功です (メニューは§6の「メニュー登録」を起動時に自動実行して作られます)。動作確認の詳細な手順 (§8動作確認相当) も併せて実施することを推奨します。

手順7: (任意) 有償プランのライセンスを後から追加する

手順3でライセンスキーを配置しなかった場合、後から次の手順で追加できます。

1. 販売元から受領したライセンスファイルを commonweal-postgres/config/lib-classes/commonweal_license.key という名前でコピーする

2. 以下のコマンドで TALON コンテナだけを再起動する

   docker compose restart talon

停止・再開・完全削除

やりたいこと	コマンド	説明
停止する	docker compose down	次回 docker compose up -d で続きから再開できます
再開する	docker compose up -d	--build は不要です (初回以降は付けなくて構いません)
完全に削除してやり直す	docker compose down -v	データベースの中身・登録した業務データ辞書や EDM もすべて削除され、次回起動時にまっさらな状態から作り直されます

バージョンアップ

新しいTLN_FUNC_DOC_PKGでバージョンアップする際の手順です。

1. commonweal-postgres/config/talon/if/REPOSITORY/TLN_FUNC_DOC_PKG/フォルダの中身を、新版のリポジトリファイル一式でフォルダごと置き換える

2. 以下のコマンドで TALON コンテナを再起動する

   docker compose restart talon

起動時に新しいバージョンを自動検知し、リポジトリ再取込とモジュールセットアップの再実行が自動で行われます。業務データ辞書・EDM・照合除外の登録データは保持されます。

バージョンの判定は、同梱のCHANGELOG.txt先頭の版数 (例Ver0.57) と、前回の完了時に記録されたマーカーとの比較で行われます。強制的に再取込したい場合は、次のようにマーカーを削除してから再起動してください。

docker exec commonweal-postgres-payara rm -f /usr/talon/.commonweal_setup_version
docker compose restart talon

トラブルシューティング

症状	対処
ログインできない / 500エラーになる	初回セットアップが終わっていない可能性があります。「手順5」のとおりdocker compose logs -f talonで[COMMONWEAL] Commonweal module setup complete.が出るまで待ってください
ログに Talon.war not found と出る	war/Talon.warが配置されていません。手順2のとおり配置してからdocker compose up -dを再実行してください
メニューに Commonweal が出ない	ログに[COMMONWEAL] ERRORが無いか確認してください。出ている場合はdocker compose restart talonで再実行できます (取込・セットアップは何度実行しても安全です)
業務データ辞書メンテナンス / EDM画面でCMN_E0108になる	上記と同じくセットアップ未完了の可能性があります。ログのERRORを確認のうえ docker compose restart talonを実行してください
「設計書出力」ボタンで ZIP がダウンロードされない	ブラウザのダウンロード警告・ポップアップブロックを確認してください(HTTP 運用のため)。詳細は §11トラブルシューティング参照
8080 / 5432 / 4848 が既に使われていて起動に失敗する	commonweal-postgres/docker-compose.ymlを開き、ports:の左側 (ホスト側) の番号を、空いている番号に変更してからdocker compose up -d --buildを再実行してください
環境をまっさらな状態からやり直したい	docker compose down -vの後docker compose up -d --buildを実行してください
本製品の画面をデザイナで編集・保存してしまい、検索が動かなくなった	config/talon/if/REPOSITORY/TLN_FUNC_DOC_PKG/はそのままに、以下を順に実行すると再取込・再セットアップされ復旧します: docker exec commonweal-postgres-payara rm /usr/talon/.commonweal_setup_version docker compose restart talon

お問い合わせ先

• Commonweal製品のライセンスに関するお問い合わせ: TALON Salesチーム ( sales「アット」talon.jp )
• Commonweal製品の技術的なお問い合わせ・不具合報告: TALON AI R&Dチーム ( ai-rd「アット」talon.jp )