【準備】

本不具合の影響により、データベース内で重複した経路分岐に関するレコードが不要データとして存在する場合があります。
不要データが存在していても、ワークフローの申請、承認、検索など一般的な操作には影響はありませんが、それが大量に存在する場合には、申請経路ステップの分岐条件の変更や削除操作時間が延伸し、これにより、サーバーに負荷をかけ、レスポンス遅延を引き起こす可能性があります。
このため、この不要データを確認、および削除するためのツールの実行方法を説明します。

■対象バージョン
バージョン 5.5.0以降のGaroon

■削除における注意点
条件分岐ステップの利用状況によっては、大量の不要データが存在する場合があります。
この場合、削除処理は長時間に及ぶため、一度の処理で削除を完了することが困難であることが想定されます。
※後述の「不要データの削除が完了するまでの時間の目安」を参照してください。

このため、実際の削除にあたっては、下記の通り進めることを推奨いたします。

1. 確認ツールで不要データ件数を確認する。
   まずはじめに、不要データの件数を確認します。
   
   
2. 削除計画を立てる。
   件数が大量に存在する場合には、ユーザーの利用頻度の低い日時やサービスが停止するバックアップ時間を避けて、複数回に分けて処理を実行してください。
   
   例：
   
   • 利用頻度の少ない休業日に、ユーザーからの利用を停止して、削除ツールを実行する
     
     
   • 日次バックアップが3時で終了する場合、3時5分から1時間実行するよう、スケジューリングする
     
     
3. 削除ツールで不要データを削除する。
   削除計画に従って削除を行います。
   

■不要データ件数確認ツール
不要データの件数を出力します。

○実行方法

1. Windowsの場合はコマンドプロンプト、Linuxの場合はコンソールを開きます。
   
   
2. CGI実行ディレクトリに移動します。
   
   例：
   Windowsの場合：
   cd C:\Inetpub\scripts\cbgrn
   
   Linuxの場合：
   cd /var/www/cgi-bin/cbgrn/
   
   DB分割構成の場合：
   cd /usr/local/cybozu/cbgrn/
   
   
3. 不要データ件数確認ツールを実行します。
   
   例：
   Windowsの場合：
   .\grn.exe -Cq code\command\count_unnecessary_workflow_data.csp
   
   Linuxの場合：
   ./grn.cgi -Cq code/command/count_unnecessary_workflow_data.csp
   
   DB分割構成の場合：
   ./grn.cgi -Cq code/command/count_unnecessary_workflow_data.csp
   

○引数
なし

○実行結果の例
実行結果はコンソール上に出力されます。
例：
------------
2020-07-28 01:45:27 Done in 0 seconds: Hit 19000 records.
------------

○留意点
不要データの件数によっては時間がかかります。
当社の事例では不要データが3億件ほどある場合には、1時間程度の時間を要しました。

※この実行時間は「不要データ件数確認ツール」の実行時間です。実際に不要データを削除するための「不要データ削除ツール」の実行時間については、後述の「■不要データの削除が完了するまでの時間の目安」をご参照の上、別途確認を行ってください。

■不要データ削除ツール
不要データを削除します。

○実行方法

1. Windowsの場合はコマンドプロンプト、Linuxの場合はコンソールを開きます。
   
   
2. CGI実行ディレクトリに移動します。
   
   例：
   Windowsの場合：
   cd C:\Inetpub\scripts\cbgrn
   
   Linuxの場合：
   cd /var/www/cgi-bin/cbgrn/
   
   DB分割構成の場合：
   cd /usr/local/cybozu/cbgrn/
   
   
3. 不要データ削除ツールを実行します。
   
   例：
   Windowsの場合：
   .\grn.exe -Cq code\command\delete_unnecessary_workflow_data.csp max_duration=180
   
   Linuxの場合：
   ./grn.cgi -Cq code/command/delete_unnecessary_workflow_data.csp max_duration=180
   
   DB分割構成の場合：
   ./grn.cgi -Cq code/command/delete_unnecessary_workflow_data.csp max_duration=180
   

○引数
max_durationで指定した分数が経過すると、ツールの実行は終了します。
指定がない場合は削除が終わるまで実行されます。

○実行結果の例
実行結果はコンソール上に出力されます。
例：
------------
2020-07-08 10:42:57 The tool was successfully completed.
2020-07-08 10:42:57 5000 rows are deleted.
2020-07-08 10:42:57 Done in 12 seconds.
------------

■不要データの削除が完了するまでの時間の目安
下記のように、一度短時間で削除できる件数を確認し、それをもとに削除完了できる時間を試算します。

1. 確認ツールで不要データの件数を確認する
   
   
2. 削除ツールを10分間実行する
   
   
3. 確認ツールで不要データの件数を確認する
   
   
4. 1と3の比較で、10分で削除できた件数を算出する
   
   
5. 残りの件数と10分で削除できた件数から、すべての削除に完了する時間を確認する