Operations Tools：セットアップ
## 概要
[Operations Tools](/ja/manual/operations-tools-overview)のセットアップおよび起動手順を説明します。
## 操作手順
### 1. ver.1.0.0からバージョンアップする場合
> **Note**
> バージョンアップではなく新規セットアップを行う場合は、「2. 実行ファイルの配置」に進んでください。
ver.1.0.0では本ソフトウェアのパフォーマンス向上のため、Syslogsテーブルにインデックスを付与する手順となっていましたが、ver.1.1.0では表示データを中間テーブルに保持する仕様になったことでパフォーマンスが向上し、インデックスが不要となりました。そのため、ここではver.1.0.0で付与したインデックスの削除方法を説明します。
> **Warning**
> 作業前にデータベースのバックアップを取得することを推奨します。
> 下記の作業後、プリザンターのバージョンアップ時にCodeDefinerを実行する場合は、パラメータ[Rds.json](/ja/manual/rds-json)のDisableIndexChangeDetectionを必ずtrue（既定値）に設定してください。falseとなっている場合はSyslogsテーブルが再作成（Migrate）され、レコード件数が多い場合はCodeDefinerの処理に時間がかかることがあります。
>
> 関連情報）パラメータ設定：Rds.json | Pleasanter
> https://pleasanter.org/manual/rds-json
dbowner権限（パラメータ設定：Rds.jsonを参照）のユーザでデータベースに接続後、インデックスを削除します。
#### SQL Serverの場合
1. Syslogsテーブルからインデックスを削除します。
```sql
drop index idx_eot_Method on SysLogs;
drop index idx_eot_CreatedTime on SysLogs;
```
2. コミットします。
```sql
commit;
```
#### PostgreSQLの場合
1. Syslogsテーブルからインデックスを削除します。
```sql
drop index idx_eot_Method;
drop index idx_eot_CreatedTime;
```
2. コミットします。
```sql
commit;
```
### 2. 実行ファイルの配置
1. サポート契約者様向け提供コンテンツよりダウンロードした「OperationsTools_x.x.x.zip」に「ExtendedLibraries」「wwwroot」が存在することを確認します。
2. プリザンターのサービスを停止します。
3. プリザンターが稼働している環境で下記ディレクトリに移動します。
| 環境 | 場所 |
|-----------|-------------------------------------|
| Windows環境 | C:\web\pleasanter\Implem.Pleasanter |
| Linux環境 | /web/pleasanter/Implem.Pleasanter |
| Azure環境 | 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環境 | C:\web\pleasanter\Implem.Pleasanter\ExtendedLibraries\OperationsTools\App_Data\Parameters\General.json |
| Linux環境 | /web/pleasanter/Implem.Pleasanter/ExtendedLibraries/OperationsTools/App_Data/Parameters/General.json |
| Azure環境 | C:\home\site\wwwroot\ExtendedLibraries\OperationsTools\App_Data\Parameters\General.json |
<div class="page"/>
6. Operations Toolsを利用できるユーザのログインIDをLogin.Usersに配列形式で指定します。
例）
General.json：修正前
```json
{
"SetupPassword": "operations-tools",
"Login": {
"Users": [ "Administrator" ]
},
"PageSize": 50,
"SQLCommandTimeout": 240,
"DefaultParametersDir": "DefaultParameters"
}
```
General.json：修正後
```json
{
"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について
共通設定に関するパラメータです。各パラメータの説明は以下のとおりです。
| パラメータ名 | 値 | 説明 |
|----------------------|---------------------|-------------------------------------------|
| SetupPassword | operations-tools | セットアップ時に入力するパスワードを指定。 |
| Login.Users | [ "Administrator" ] | Operations Toolsを利用できるユーザのログインIDを配列形式で指定。 |
| PageSize | 50 | ページ送りの既定値を指定。 |
| SQLCommandTimeout | 240 | SQLコマンドのタイムアウト時間を秒単位で指定。 |
| DefaultParametersDir | DefaultParameters | 変更前のパラメータ配置ディレクトリを指定。（パラメータ一覧画面用） |
#### パラメータ：BackgroundService.jsonについて
データ表示用の中間テーブルをバックグラウンドで同期する処理に関するパラメータです。各パラメータの説明は以下のとおりです。
| パラメータ名 | 値 | 説明 |
|--------------------------------------|----------------------|--------------------------------|
| IntermediateTableSynchronize.Enable | true | バックグラウンド処理の有効化/無効化をtrue/falseで指定します。 |
| IntermediateTableSynchronize.RunTime | [ "00:00", "12:00" ] | バックグラウンド処理を実行する時間を配列形式で指定します。 |
#### 補足：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で指定した時間にバックグラウンドで同期されます。直近のデータを見たい場合などは「表示データを最新化」ボタンを押下してデータを手動で同期してください。
#### トラブルシューティング
Q. 管理ページの画面にアクセスした際、以下のように「ライセンスファイルが正しく設定されていないか、またはライセンスファイルが無効です。」のメッセージが表示される。
A. プリザンター本体に有効なライセンスファイルが配置されていることを確認してください。
---
Q. 一部の画面について明細情報などの結果が表示されない。
A. 対象環境のデータ量によってはセットアップ処理がタイムアウトで中断されることにより、一部画面の結果が表示されないことがあります。その場合は、以下の手順をお試しください。
＜手順＞
1. Operations Tools用のパラメータファイル：General.jsonの"SQLCommandTimeout"について値を調整してください。
```json
{
"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がブランクとなっていれば成功です。）
## 関連情報
<div id="ManualList"><ul><li><a href="/ja/manual/rds-json">パラメータ設定：Rds.json</a><span>2024/11/07 up</span></li></ul></article>
<ul><li><a href="/ja/manual/operations-tools-overview">Operations Tools：機能概要</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-operation-general">Operations Tools：運用レポート：全体（利用状況／性能状況）</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-operation-performance-by-day">Operations Tools：運用レポート：性能状況：日別</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-operation-performance-by-time">Operations Tools：運用レポート：性能状況：時間別</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-usage-by-day">Operations Tools：利用状況詳細：日別</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-usage-by-month">Operations Tools：利用状況詳細：月別</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-usage-login">Operations Tools：利用状況詳細：詳細：ログイン履歴</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-usage-outgoingmails">Operations Tools：利用状況詳細：詳細：メール送信履歴</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-usage-api-requests">Operations Tools：利用状況詳細：詳細：APIリクエスト履歴</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-monitoring-alert-setting">Operations Tools：監視アラート：アラート設定</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-monitoring-system-talbes">Operations Tools：監視アラート：システムテーブル</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-monitoring-sites">Operations Tools：監視アラート：サイト</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/opetaions-tools-sites">Operations Tools：サイト情報一覧</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-permissions">Operations Tools：アクセス権一覧</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-parameters">Operations Tools：パラメータ一覧</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-common-site-menu">Operations Tools：共通機能：サイドメニュー</a><span>2025/02/14 up</span></li>
<li><a href="/ja/manual/operations-tools-common-export">Operations Tools：共通機能：エクスポート</a><span>2025/02/14 up</span></li></ul></article></div><input id="SearchTextHidden" type="hidden" value="" />
