【WA0134】シナリオ停止の強い味方「ログ機能 3種」のご紹介
こんにちは、NTTデータ WinActor技術支援チームです。
いつもユーザーフォーラムをご利用いただき、ありがとうございます。
みなさん、WinActorを使っていると、
エラーが発生してシナリオが止まってしまった、など経験はありませんか?
そんな場合は今回ご紹介するログ機能で調査しましょう!
●「WinActorのログ」とは?
シナリオを実行した日時や、どのシナリオを実行した、どのグループを実行した、など
全てのノード部品の実行内容が時系列で表示されます。
では、どのような場合にログ出力機能って使うんでしょうか?
◆シナリオ作成中:エラーメッセージの確認、デバッグでの動作チェック、実行時間測定
◆本番運用中:シナリオが正常に終了しなかった時、繰り返し回数/分岐方向・異常終了時直前のノードの実行結果のチェック
WinActorのログの出力方法は、手動・ライブラリ・オプション設定の3つがあります。
そこで今回は、この3つのログ取得方法をそれぞれご紹介します!
1.手動でのログ取得
シナリオ作成中にエラーが発生した!って時に手動でログを見る機会が多いですよね。
「ログ出力」しなくても、「ログ表示エリア」から直接選択して、
必要部分だけをメモ帳等に貼り付けする方法や「ログ保存」から任意の場所保存することもできます。(文字コードは「UTF-8」)
※注意点※
表示される行数の上限はデフォルトで1000行となっており、上限を超えると古いログから100行単位で消去されます。
そのため、繰り返し回数が多いシナリオを実行する場合などは、
「ツール>オプション>その他」からログの表示上限を増やしておくことをおすすめします!
【作業手順】
①機能編集エリアの「ログ出力」をクリックし、ログ出力ツールバーの「ログ保存」任意の場所に保存する
※機能編集エリアを閉じている場合、メニューバー「表示」 > 「ログ出力」で再表示できます。
※シナリオ実行前に「ログクリア」することをオススメします!
2.ライブラリを利用したログ取得
ログ出力が可能なライブラリ3つを紹介いたします。
・ライブラリ「ログ出力(ファイル指定)」
シナリオの先頭に配置することで、シナリオごとにログを保存することが可能となります。
また、プロパティ内で指定したファイルに実行開始~実行終了までのログのみが保存されるので、
「3.オプション設定によるログ取得」にて紹介する方法とは異なり、
シナリオ実行の前後のログは記載されないシンプルなログを出力することができます。
・ライブラリ「ログメッセージ出力」
プロパティ内で設定した任意のメッセージをログ内に出力することができます。
変数を選ぶこともできるので、変数で取得した値をログに表示させることもできます。
・ライブラリ「ログ記録」
プロパティ内で設定した「書き込みラベル」と「書き込みデータ」を任意のファイルに記録することができます。
「ファイルフォーマット(文字コード)」が選択できるようになっていて、
「Ascii形式」、「Unicode形式」、「システム規定」から選ぶことが可能です。
※注意点※
「3.オプション設定によるログ取得」で紹介しているメニューバー「ツール」 > オプション >「ログ」のタブにて
「実行ログを常に出力する」が有効になっている場合、こちらに指定しているファイルにもログが出力されます。
◆ライブラリ「ログ出力(ファイル指定)」の例
【作業手順】
① 01_WinActor制御 > 08_実行ログ > ライブラリ「ログ出力(ファイル指定)」をシナリオの先頭へ配置し、
プロパティを開いてログを保存するファイル名を指定する
②シナリオを実行する
③プロパティ内で指定したファイルにログが保存される
◆ライブラリ「ログメッセージ出力」の例
◆ライブラリ「ログ記録」の例
3.オプション設定によるログ取得
オプション設定によるログ取得はシナリオごとの設定が不要なため、本番環境の運用を行う際にお勧めします!
不具合が発生した場合、ログを追うことで、シナリオの実行状況を把握することが可能です。
また、ログを分割して取得することも可能です!
分割方法は、分割しない・日付で分割・ファイルサイズで分割・シナリオ実行毎に分割が選択できます。
「日付で分割」に設定すると、日付が入ったファイルが自動で生成されるので
古いログは削除するという運用のときに楽になります!
※注意点※
・作成されたファイルは自動的に削除されませんので定期的にファイル削除してください。(ディスク容量を圧迫してしまいます。)
・②のチェックを外すと、設定したログファイルのパス情報が消えてしまいますので、こちらも注意が必要です。
◆「日付で分割1」の例
【作業手順】
①メニューバー「ツール」 > オプション >「ログ」のタブを開く
②「実行ログを常に出力する」にチェックを入れる
③「ログ分割1」を選択
④ログが出力されるファイルを指定する
⑤シナリオを実行すると日付が入ったファイルが生成される
指定したファイル名の後ろに日付が追記されてますね!
これで日付毎にファイルが作成されていることがわかります!
出力する方法でログの内容に違いがありますね。
シナリオ作成中の確認、突発的なエラーでログを確認したいのなら、
【1.手動でのログ取得】で操作したほうが早いです。
特定のシナリオのみでログを出力したい、変数の値や追加の情報をログに残したいなら、
【2.ライブラリを利用したログ取得】で対応ができますね!
本番運用のログ保存用、全シナリオを記録したいなら、
【 3.オプション設定によるログ取得】がオススメです。
ぜひ、必要に応じてご活用ください。
★ログに関連する投稿はこちら↓↓
【WA0076】「問い合わせ用情報収集」の中身を確認してみました
【動作検証環境】
WinActor Ver.7.4.3
<お願い>
本投稿に関しての問合せにつきましては、
恐れ入りますがコメントではなく、個別問合せにてお願いいたします。
★お問合せ方法はこちらのコラムをご参照ください