開発・運用サポート

テナントマネージャーは、テナントの新規作成、削除、一覧表示の機能を持っています。

Swingで作成されたGUI版と、バッチ・シェルで作成されたCUI版があります。 GUI版では上の３つの機能全てを提供しています。 CUI版では新規作成、削除機能のみを提供しています。 AWS環境などへtelnet接続して利用する場合は、CUI版を利用してください。

どちらの形式もバッチを実行して起動します。 バッチを実行するにはバッチの共通設定を参照して環境を設定してください。

GUI版を起動する場合は、 tenant_gui.bat （シェル版はありません）から実行します。

画面が起動すると登録されているテナントの一覧が表示されます。 Partition List ボタンは、MySQL及びPostgreSQLの場合のみ表示されます。

Create Default Tenant ボタンをクリックして新規作成ダイアログを表示します。

設定可能な項目は以下の通りです。

一覧から削除したいテナントを選択し、 Remove Tenant ボタンをクリックします。

MySQLの場合、内部で利用しているデータベーステーブルに対して、テナントIDごとにパーティションを作成します。 通常、テナントを新規で作成する際にパーティションを作成します。 ただしパーティションの作成処理はテーブルロックを伴うため、複数のテナントを運用している環境などでは、 パーティション作成処理中に他のテナントに対しても影響が発生します。 これを回避するために、データベースの初期構築時やAPサーバがオフラインのとき、 ユーザーアクセスが少ない時間帯に前もってパーティションを作成できるようにする機能が Partition List です。

Partition List ボタンをクリックすると、テーブルに対してすでに作成されているパーティション情報を表示します。 Max Tenant Id には、すでに作成済みのパーティション最大のテナントIDが表示されます。 Tenant List ボタンをクリックすることでテナントの一覧画面に戻ります。

パーティションを作成する場合、 Create Partition ボタンをクリックします。

Max Tenant ID に作成する最大のテナントID(数値)を指定して、 Create ボタンをクリックすると、すでに登録済みのパーティションから１ずつ増やしたパーティションを作成します。

例えば 10 を入力した場合、すでに 6 まで作成されていれば、 7、8、9、10 用のパーティションが作成されます。 この実行の間、テーブルロックが発生します。

パーティション対応のPostgreSQLの場合、内部で利用しているデータベーステーブルに対して、テナントIDごとにパーティションを作成します。 通常、テナントを新規で作成する際にパーティションを作成しますが、前もってパーティションを作成できるようにする機能が Partition List です。

Partition List ボタンをクリックすると、パーティション対応のテーブルに対してすでに作成されているパーティション情報を表示します。 Max Tenant Id には、すでに作成済みのパーティション最大のテナントIDが表示されます。PostgreSQLではテナントIDの採番はシーケンスで行われるため、 表示されているテナントIDが最終のテナントIDとは限りません（最後に作成されたテナントが削除された場合など）。 Tenant List ボタンをクリックすることでテナントの一覧画面に戻ります。

パーティションを作成する場合、 Create Partition ボタンをクリックします。

Max Tenant ID に作成する最大のテナントID(数値)を指定して、 Create ボタンをクリックすると、すでに登録済みのパーティションから１ずつ増やしたパーティションを作成します。

例えば 10 を入力した場合、すでに 6 まで作成されていれば、 7、8、9、10 用のパーティションが作成されます。

CUI版のテナント作成バッチを起動する場合は、 tenant_create.bat（sh） から実行します。 環境情報が表示された状態で止まるので、何かKEYを入力してください。

ここからテナント作成に必要な情報をウィザード形式で入力します。 表示されるメッセージに従って設定値を入力してください。

全て設定が終わると、実行前に確認メッセージが表示されます。 yesでテナントの作成を開始します。

正常に作成されると SUCCESS が出力されます。 何かキーを入力して終了します。

CUI版のテナント削除バッチを起動する場合は、 tenant_delete.bat（sh） から実行します。 環境情報が表示された状態で止まるので、なにかKEYを入力してください。

ここからテナント削除に必要な情報をウィザード形式で入力します。 表示されるメッセージに従って設定値を入力してください。

テナント作成同様、 -show 、 -env が利用できます。

全て設定が終わると、実行前に確認メッセージが表示されます。 yesでテナントの削除を開始します。

正常に削除されると SUCCESS が出力されます。 何かキーを入力して終了します。

CUI版のMySQL用パーティション作成バッチを起動する場合は、 mysql_partition.bat（sh） から実行します。 環境情報が表示された状態で止まるので、なにかKEYを入力してください。

ここからパーティション作成に必要な情報をウィザード形式で入力します。 表示されるメッセージに従って設定値を入力してください。

テナント作成同様、 -show 、 -env が利用できます。

全て設定が終わると、実行前に確認メッセージが表示されます。 yesでパーティション作成を開始します。

正常に作成されると SUCCESS が出力されます。 何かキーを入力して終了します。

CUI版のPostgreSQL用パーティション作成バッチを起動する場合は、 postgres_partition.bat（sh） から実行します。 環境情報が表示された状態で止まるので、なにかKEYを入力してください。

ここからパーティション作成に必要な情報をウィザード形式で入力します。 表示されるメッセージに従って設定値を入力してください。

テナント作成同様、 -show 、 -env が利用できます。

全て設定が終わると、実行前に確認メッセージが表示されます。 yesでパーティション作成を開始します。

正常に作成されると SUCCESS が出力されます。 何かキーを入力して終了します。

サイレント形式によるテナント作成バッチを起動する場合は、 tenant_silent.bat（sh） から実行します。 サイレント形式では、実行前の確認は行わず即座にテナントの作成を行います。

サイレント形式の場合、実行に必要な情報は設定ファイルで指定します。

設定ファイルは、 conf/tenant-create-config.properties として配布しています。 必要に応じて編集してください。

もし設定ファイルのパスやファイル名を変更した場合は、パッチの TENANT_CONFIG を変更してください。

正常に作成されると SUCCESS が出力されます。

各環境間でテナントに対するデータを移行する場合、iPLAssではメタデータとエンティティデータが対象になります。 メタデータ、エンティティデータそれぞれに移行ツールを提供しています。

ツールは、AdminConsoleのToolsとバッチやシェルの形式で提供していますので、 利用場面に応じて選択してください。

メタデータの移行には、AdminConsoleのMetaDataExplorerを利用します。 MetaDataExplorerの詳細についてはMetaDataExplorerを参照してください。
メタデータのエクスポート、インポートについては、バッチも提供しています。

エンティティデータの移行には、AdminConsoleのEntityExplorerを利用します。 エンティティデータに含まれるバイナリファイルも一緒に移行したい場合は、Packaging機能を利用してください。 EntityExplorerの詳細についてはEntityExplorerを参照してください。

メタデータとエンティティデータを一緒に移行する場合は、AdminConsoleのPackagingを利用します。 Packagingの詳細についてはPackagingを参照してください。
Pacakageのエクスポート、インポートについては、バッチも提供しています。

メタデータの更新作業の際などに、テナントで提供しているサービス（画面やWebApi）を一時的に利用不可にできる機能です。 サービスは以下の単位で利用不可できます。

それぞれの利用停止範囲は、ログインユーザー情報やアクセスパス（対象Action、対象WebApi、対象Entity）を参照して、GroovyScriptで制御できます。

EQLWorksheetではEQLを実行し、結果を一覧で表示できます。 Functionや条件文、関数やバインド変数（Notes参照）の利用もできます。 また、EQLWorksheetでは更新や削除はできません。 AdminConsole上で更新や削除を行う場合は、EntityExplorerを利用してください。

EQLを作成し、 Execute ボタンをクリック（もしくはF8押下）することで、実行結果とメッセージログを確認する事ができます。 また、 Select Entity ボタンをクリックすることで、選択したEntityに対するSelect用EQLを自動生成できます。 尚、EQLの文法については画面上のNotes、およびEQL Referenceを参考にして下さい。

EQLが入力された状態で Export CSV ボタンをクリックすると、EQLの実行結果をCSVで出力できます。

EntityExplorerではEntityデータの確認、操作、メンテナンスを行うことができます。 Entityに対するツール機能は、このEntityExplorerに集約されています。

MetaDataExplorerでは、メタデータの確認、操作、メンテナンスを行うことができます。 メタデータに対するツール機能は、このMetaDataExplorerに集約されています。

いくつかの条件で絞込みを行うことができます。

一覧には、登録されているメタデータがパス（各メタデータ固有のパス＋名前）ツリーで表示されます。

一覧上のメタデータをダブルクリックすることでメタデータの編集画面を表示します。

指定されたメタデータをXMLファイルとしてエクスポートすることが可能です。 エクスポートされたXMLファイルをインポートすることもできます。

またメタデータの名前の一覧をCSVファイルとして出力することも出来ます。

インポートファイルをアップロード後、XMLファイルの解析が終わるとインポート可能なメタデータがツリー表示されます。 既存のメタデータと取り込むメタデータの状態によってはエラーや警告が表示されることがあります。 その際は一度両メタデータを確認し、インポートしても問題ないか確認してください。
またテナント情報がXMLに含まれる場合、更新対象の項目を選択するダイアログを表示します。 インポートする項目を選択してください。

ローカルのメタデータ（Rdb）をタグとして保存したり、そのタグからメタデータを復元する機能です。 メタデータを復元する際は、純粋な復元ではなく再インポートとなります。

登録されているメタデータの整合性をチェックします。 MetaDataSettings メニュー上部からも同様のステータスチェックが実行可能です。

Execute をクリックするとステータスチェックが始ります。 エラーが発生した場合は、画面上にエラーが表示されます。 一覧を選択すると、「エラーメッセージ」にエラー内容が表示されます。 一覧をダブルクリックすると、エラーが発生しているメタデータの編集画面を表示します。

PackagingはメタデータとEntityデータをまとめて、１つのPackage（Zipファイル）として管理する機能です。 作成したPackageはエクスポート、インポートが可能で、テナント間のデータ移行をサポートします。

Create を実行すると、Packageの作成画面を表示します。

Packageに含めるメタデータ、Entityデータを選択します。 ダイアログ上下のボタンで画面を切り替えることができます。 最後に Execute Pack でNameを指定して、 Create Package を実行します。

対象となるEntityデータの件数が多い場合は非同期で実行してください。 非同期で実行した場合、進捗状況は一覧画面で確認します。

同期で実行した場合、Packageの作成が完了すると、ダウンロード用のボタンが表示されます。

また非同期で実行した場合や同期で実行した場合でも、 １度作成したPackageは一覧上からダウンロードしたり、インポートすることが可能です。

別の環境などで作成したPackageを取り込むには、 Upload ボタンを実行します。 アップロード完了後、Packageのインポート画面を表示します。 また既にアップロード済みのPackageや自身で作成したPackageは一覧をダブルクリックすることでインポート画面を表示します。

Entityデータを取り込む場合は、オプションを設定します。 オプションについては、 Entityデータのインポートオプション を参照してください。

Import をクリックするとインポートを開始します。 インポート対象にテナント情報が含まれる場合、MetaDataExplorerと同様に項目の選択ダイアログが表示されます。

PermissionExplorerはセキュリティに関連する定義を一括で設定する機能です。 汎用画面の権限情報で各権限を個別に設定することも出来ますが、PermissionExplorerを利用することで、ロール×権限の表形式で一括管理できます。

BuiltinAuthUserExplorerは標準の認証機能に対するユーザーをメンテナンスするための機能です。

Userエンティティに対する条件指定とロック状態やパスワード有効期限などのアカウント状態に対する条件指定が可能です。

Userエンティティの属性（アカウントID、名前（カナも可）、メール、有効期間残日数（EndDate））やEQLのWhere句を直接指定できます。

選択したユーザーのエラー回数をリセットします。 ログイン時のパスワードエラーが規定回数を超えた場合、アカウントロックとなりログインができなくなります。 エラー回数のリセットを行うことで、再度ログインができるようになります。

なお、エラー回数については、正しいパスワードによるログインを行うか、管理者ユーザー等でユーザーのパスワードリセットを行うことでもリセットできます。

QueueExplorerは非同期Commandやスケジュールタスク等の非同期タスクをメンテナンスするための機能です。 キュー毎に積まれているタスクの一覧表示や、過去の実行履歴、未完了のタスクのキャンセルといった操作ができます。

なお、非同期CommandやスケジュールタスクはRdbQueueServiceの「useQueue」をtrueにしないと実行できません。 QueueExplorerについても非同期タスクが実行できない状態では動作しません。

一覧で選択したTaskをキャンセルすることができます。 完了しているタスクは選択できません。

一覧で選択したTask情報を削除します。 削除したタスク情報は参照したり、元に戻すことができません。

実行履歴として過去に実行されたTaskを表示します。 背景色が濃い青で表示されます。

各Metaデータの多言語情報の確認、更新を行うことが可能です。 テナントの多言語設定で多言語を利用する設定をしている場合は利用可能言語全てを登録する必要があります。 例えば、利用可能言語として日本語、英語を設定しており、各多言語設定で英語のみ登録していた場合、汎用画面にてユーザーが日本語を選択すると空表示となります。

一覧上のメタデータをダブルクリックすることで画面下部に多言語として編集可能な項目が表示されます。 表をダブルクリックすると行単位で編集状態になります。 編集後に Save ボタンをクリックすることで保存されます。

編集エリアに表示しているメタデータの多言語情報をCSVファイルとしてエクスポート、インポートすることも可能です。 メタデータ単位でエクスポート、インポートしたい場合は、画面下部の Export 、 Import ボタンを実行します。

複数のメタデータをまとめてエクスポート、インポートしたい場合は、画面上部のメタデータを選択後、 ExportCSV 、 ImportCSV を利用してください。

LogExplorerは、テナントのログ出力設定を行ったり、ログファイルをダウンロードする機能です。 出力可能なフォルダやファイル名パターンは、service-configのAdminConsoleServiceで指定します。

動的にログ出力条件を変更することが可能です。 「一時的にある特定ユーザーの操作のみ、DEBUGレベルで出力する。」といったことが可能です。 動的にログ出力条件を変更するためには、設定ファイル（service-configおよびlogback.xml）の設定が必要となります。詳細は LoggingService を参照ください。

次の項目を設定可能です。

Gradleの copyRuntimeLibs タスクを実行してツールの実行に必要なライブラリを「lib」ディレクトリにコピーします。

ツールの実行に必要となる共通環境変数を設定します。 環境変数は tools_env.bat （Linuxの場合は「tools_env.sh」）に対して設定します。

設定する環境変数は以下のものです。

tools_env.bat には予め変数が定義されているので、値を設定してください。

MySQL環境に対してテナントを作成する場合、テナントごとにPartitionを作成するDDLが実行されます。 そのため「SERVICE_CONFIG_NAME」で指定した「xxx-service-config.xml」内のDB接続ユーザーに対して、「ALTER TABLE」権限が必要となります。 権限を持ったユーザーが、アプリケーションからの接続に利用するユーザーと異なる場合は、ツールを実行する前に mtp-service-config.xml 内の接続ユーザーを変更してください。

パーティション対応のPostgreSQL環境に対してテナントを作成する場合、テナントごとにPartitionを作成するDDLが実行されます。 そのため「SERVICE_CONFIG_NAME」で指定した「xxx-service-config.xml」内のDB接続ユーザーに対して、「ALTER TABLE」権限が必要となります。 権限を持ったユーザーが、アプリケーションからの接続に利用するユーザーと異なる場合は、ツールを実行する前に mtp-service-config.xml 内の接続ユーザーを変更してください。

Packageはテナントに登録されているメタデータやEntityデータをzip形式でまとめたものです。 Package機能を利用して、テナントのメタデータやEntityデータを更新したり、別のテナントに移行することができます。

AdminConsole上にも同様の機能があります。 このバッチは、AdminConsole上のPackagingと連携しています。

以下に示すメトリクスの収集を標準でサポートしています。
どのメトリクスを収集対象とするかは、設定ファイルで指定可能です。また、カスタムのメトリクスを登録することも可能です。詳細は、 MicrometerService を参照してください。
iPLAssでは、全てのメトリクスに対して、基盤側で host タグを自動付与しており、その値には、デフォルトでサーバのホスト名が入ります。

以下のモニタリングシステムへのメトリクス連携を標準でサポートします。
どのモニタリングシステムを利用するかは、設定ファイルで指定可能です。 詳細は、 MicrometerService を参照してください。

Micrometerモジュールを動作させるには、以下のステップが必要になります。

iPLAssをデータフローの送信元または送信先としてAppFlowに統合し、データフローを実行するための手順を以下に示します。