セットアップ

概要¶

Operations Toolsのセットアップおよび起動手順を説明します。

制限事項¶

• SQL Serverの互換性レベルは130以上が必要です。

  互換性レベルとは

  互換性レベルについては、下記公式ページを参照すてください。

  https://learn.microsoft.com/ja-jp/sql/t-sql/statements/alter-database-transact-sql-compatibility-level?view=sql-server-ver16

操作手順¶

ver.1.0.0からバージョンアップする場合¶

ver.1.0.0では本ソフトウェアのパフォーマンス向上のため、Syslogsテーブルにインデックスを付与する手順となっていましたが、ver.1.1.0では表示データを中間テーブルに保持する仕様になったことでパフォーマンスが向上し、インデックスが不要となりました。そのため、ここではver.1.0.0で付与したインデックスの削除方法を説明します。

dbowner権限（パラメータ設定：Rds.jsonを参照）のユーザでデータベースに接続後、インデックスを削除します。

実行ファイルの配置¶

1. Operations ToolsのReleasesページよりダウンロードした「OperationsTools_x.x.x.zip」に「ExtendedLibraries」「wwwroot」が存在することを確認します。
2. プリザンターのサービスを停止します。

3. プリザンターが稼働している環境で下記ディレクトリに移動します。

   Windows環境Linux環境Azure環境

   C:\web\pleasanter\Implem.Pleasanter
   

   /web/pleasanter/Implem.Pleasanter
   

   C:\home\site\wwwroot
   

4. 「OperationsTools_x.x.x.zip」の「ExtendedLibraries」「wwwroot」をGUI操作またはコマンド実行で配置します。Windows環境の場合、配置結果は以下のようになります。

   C:\web\pleasanter\Implem.Pleasanter\
   　├ App_Data\
   　└ ExtendedLibraries\　★配置
   　　└ OperationsTools\
   　├ Libraries\
   　├ runtimes\
   　├ Views\
   　└ wwwroot\
   　　├ bundles\
   　　├ content\
   　　├ images\
   　　├ operations-tools\　★配置
   　　├ scripts\
   　　└ styles\
   

   Note

   Linux環境またはAzure環境の場合は後述の補足ページを参考に作業を実施してください。

5. 下記ディレクトリのGeneral.jsonを任意のエディタで開きます。プリザンターのパラメータ設定ファイルにも同名のファイルがあります。間違えないように注意してください。

   Windows環境Linux環境Azure環境

   C:\web\pleasanter\Implem.Pleasanter\ExtendedLibraries\OperationsTools\App_Data\Parameters\General.json
   

   /web/pleasanter/Implem.Pleasanter/ExtendedLibraries/OperationsTools/App_Data/Parameters/General.json
   

   C:\home\site\wwwroot\ExtendedLibraries\OperationsTools\App_Data\Parameters\General.json
   

6. Operations Toolsを利用できるユーザのログインIDをLogin.Usersに配列形式で指定します。

   General.json：修正前
   1 2 3 4 5 6 7 8 9	{ "SetupPassword": "operations-tools", "Login": { "Users": [ "Administrator" ] }, "PageSize": 50, "SQLCommandTimeout": 240, "DefaultParametersDir": "DefaultParameters" }

   General.json：修正後
   1 2 3 4 5 6 7 8 9	{ "SetupPassword": "operations-tools", "Login": { "Users": [ "Administrator", "AdminUser1", "AdminUser2" ] }, "PageSize": 50, "SQLCommandTimeout": 240, "DefaultParametersDir": "DefaultParameters" }

7. ご利用中のプリザンターのバージョンにおける変更前のパラメータJSONファイルをDefaultParametersフォルダ配下に配置してください。

   配置場所の例

   C:\web\pleasanter\Implem.Pleasanter\ExtendedLibraries\OperationsTools\App_Data\
   　└ DefaultParameters\
   　　├ Api.json　★配置
   　　├ Authentication.json　★配置
   　　├ ・・・
   

   Note

   DefaultParametersフォルダ配下に配置することで、後述のパラメータ一覧画面で差分を比較することができます。

   変更前のパラメータJSONファイルがお手元にない場合は、GitHubのリリース用ページからダウンロードして取得してください。
   https://github.com/Implem/Implem.Pleasanter/releases

8. プリザンターのサービスを開始します。

   Note

   Operations Toolsのバージョンアップをする際は、プリザンターをサービス停止後に「ExtendedLibraries」「wwwroot/operations-tools」を削除してから上記1～8の手順を実施してください。

パラメータ：General.jsonについて¶

共通設定に関するパラメータです。各パラメータの説明は以下のとおりです。

パラメータ：BackgroundService.jsonについて¶

データ表示用の中間テーブルをバックグラウンドで同期する処理に関するパラメータです。各パラメータの説明は以下のとおりです。

補足：Linux環境の場合¶

Linux環境の場合は下記の手順を参考にしてください。（Windowsのローカル環境から実施する場合を想定）

1. 下記コマンドでプリザンターのサービスを停止します。

   sudo systemctl stop pleasanter
   

2. 実行ファイル「ExtendedLibraries」「wwwroot」をそれぞれzipで圧縮します。

3. WinSCPなどのツールで「/web/pleasanter/Implem.Pleasanter」にバイナリでアップロードします。

4. 下記コマンドでディレクトリを移動します。

   cd /web/pleasanter/Implem.Pleasanter
   

5. 下記コマンドでzipファイル「ExtendedLibraries.zip」を展開します。

   sudo unzip -q -d /web/pleasanter/Implem.Pleasanter ExtendedLibraries.zip
   

6. 下記コマンドでzipファイル「wwwroot.zip」を展開します。

   sudo unzip -q -d /web/pleasanter/Implem.Pleasanter wwwroot.zip
   

7. ディレクトリ「ExtendedLibraries」配下の所有者を変更します。

   sudo chown -R <プリザンターを起動するユーザ> /web/pleasanter/Implem.Pleasanter/ExtendedLibraries
   

8. ディレクトリ「wwwroot/operations-tools」配下の所有者を変更します。

   sudo chown -R <プリザンターを起動するユーザ> /web/pleasanter/Implem.Pleasanter/wwwroot/operations-tools
   

9. 下記コマンドでプリザンターのサービスを開始します。

   sudo systemctl start pleasanter
   

補足：Azure環境の場合¶

Azure環境の場合は下記の手順を参考にしてください。

1. App Serviceを停止します。
2. 実行ファイル「ExtendedLibraries」「wwwroot」をそれぞれzipで圧縮します。
3. AzureのKuduを開き、「C:\home\site\wwwroot>」に移動します。

4. zipファイル「ExtendedLibraries.zip」をドラッグ＆ドロップでアップロードします。

   

5. zipファイル「wwwroot.zip」をドラッグ＆ドロップでアップロードします。

   

6. App Serviceを開始してプリザンターを起動します。

3. セットアップの実行¶

1. 下記URLにアクセスします。

   http://{プリザンターのパス}/operations-tools/admin
   

   

2. パスワードを入力し、セットアップボタンをクリックします。

   Note

   パスワードはGeneral.jsonで設定したSetupPasswordの値（初期値は「operations-tools」）です。

3. メッセージ「セットアップの処理中です。しばらくお待ち下さい。」が表示されます。

   

4. メッセージ「セットアップが完了しました。」が表示されたらセットアップは完了です。

   

   Note

   上記操作によりOperations Tools用のテーブル一式（プレフィックスが「_eot」のテーブル）が作成されます。

   Note

   一部の画面の表示データはセットアップを実施したタイミングで中間テーブルに作成され、Operations ToolsのパラメータBackgroundService.jsonのIntermediateTableSynchronize.RunTimeで指定した時間にバックグラウンドで同期されます。直近のデータを見たい場合などは「表示データを最新化」ボタンを押下してデータを手動で同期してください。

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

Q1. 管理ページの画面にアクセスした際、以下のように「ライセンスファイルが正しく設定されていないか、またはライセンスファイルが無効です。」のメッセージが表示される。

A1. プリザンター本体に有効なライセンスファイルが配置されていることを確認してください。

Q2. 一部の画面について明細情報などの結果が表示されない。

A2. 対象環境のデータ量によってはセットアップ処理がタイムアウトで中断されることにより、一部画面の結果が表示されないことがあります。その場合は、以下の手順をお試しください。

1. Operations Tools用のパラメータファイル：General.jsonの"SQLCommandTimeout"について値を調整してください。

   General.json
   1 2 3 4 5 6 7 8 9	{ "SetupPassword": "operations-tools", "Login": { "Users": [ "Administrator", "AdminUser1", "AdminUser2" ] }, "PageSize": 50, "SQLCommandTimeout": 240, <-- 値を調整する "DefaultParametersDir": "DefaultParameters" }

2. プリザンターを再起動します。

3. Operations Toolsの管理ページ画面から「表示データを最新化」ボタンをクリックします。
4. [_eot_JobHistory]テーブルのログを確認し、Status, ErrMessage, ErrStackTraceの内容を確認します。
   （Statusが'Success'となっており、ErrMessage, ErrStackTraceがブランクとなっていれば成功です。）

関連情報¶

• Operations Tools：共通機能：エクスポート
• パラメータ設定：Rds.json
• Operations ToolsのReleasesページ