メッセージのログ

IBM RPA Studio コンソールまたは IBM RPA Control Centerにメッセージを記録します。 必要に応じて、Windows イベント・ログにもメッセージを記録します。

IBM RPA Studio によるロボットの実行では、その同じツールのコンソールにメッセージが記録されます。 残りの実行は、 IBM RPA Control Centerでログ・メッセージを実行します。

構文

logMessage --message(String) --type(EventType) [--logonwindows(Boolean)] [--logname(String)] [--source(String)] [--eventid(Numeric)]

入力パラメーター

以下の表は、このコマンドで使用可能な入力パラメーターのリストを示しています。 この表では、 IBM RPA Studioのスクリプト・モードで作業しているときのパラメーター名と、それに相当する Designer モードのラベルを確認できます。

「デザイナー」モードのラベル 「スクリプト」モードの名前 必須 使用可能な変数タイプ 説明
メッセージ message Required Text 出力として返されるメッセージ。
タイプ type Required EventType ログに記録されたメッセージのイベントのタイプ。 受け入れられるタイプについて詳しくは、type パラメーター・オプションを参照してください。

注:タイプは、Windows イベント・ビューアーのロギング・レベルに対応しています。 この機能を使用するには、「Windows イベントのログ」パラメーターを有効にします。
Windows イベントのログ logonwindows Optional Boolean Windows イベント・ログにメッセージを記録するためのオプション。これは、Windows イベント・ビューアーに表示されます。
ログ logname Optional. Visible only if logonwindows is enabled Text Windows イベント・ビューアーでイベントが記録されるログ名。 詳しくは、logname パラメーター・オプションを参照してください。
ソース source Optional. Visible only if logonwindows is enabled Text イベント・ログを生成したアプリケーションに対応するソース。これは、Windows の既存のアプリケーションでなければなりません。

注:データが定義されていない場合、デフォルトは「アプリケーション」です。
イベント ID eventid Optional. Visible only if logonwindows is enabled Number Windows イベント・ビューアーでのイベント・ログの識別番号。

type パラメーター・オプション

次の表は、type 入力パラメーターで使用可能なオプションを示しています。 この表は、「スクリプト」モードで作業するときに使用可能なオプションと、「デザイナー」モードでそれに相当するラベルを示しています。

「デザイナー」モードのラベル 「スクリプト」モードの名前 説明
エラー Error エラーは、ログに記録されたメッセージが適合するイベントのタイプです。
情報 Info 情報は、ログに記録されたメッセージが適合するイベントのタイプです。
警告 Warning 警告は、ログに記録されたメッセージが適合するイベントのタイプです。

logname パラメーター・オプション

次の表は、logname 入力パラメーターで使用可能なオプションを示しています。 この表は、「スクリプト」モードで作業するときに使用可能なオプションと、「デザイナー」モードでそれに相当するラベルを示しています。

「デザイナー」モードのラベル 「スクリプト」モードの名前 説明
アプリケーション application メッセージは、Windows イベント・ビューアーに「アプリケーション」ログとして記録されます。
安全 safety このメッセージは、Windows イベント・ビューアーに「安全」ログとして記録されます。
構成 configuration このメッセージは、Windows イベント・ビューアーに「構成」ログとして記録されます。
システム system このメッセージは、Windows イベント・ビューアーに「システム」ログとして記録されます。
転送されたイベント eventsforwarded このメッセージは、Windows イベント・ビューアーに「転送されたイベント」ログとして記録されます。

例

例 1: 「メッセージ」パラメーターに直接書き込まれたメッセージを表示します。

logMessage --message "Execution occurred without errors!\r\n" --type "Info"
// Return the following output on the console:
// "Execution occurred without errors!"

例 2: 変数「numericValue」の内容を、「The contents of the variable 'numericValue' is:」という情報テキストとともに表示します。

defVar --name numericValue --type Numeric --value 100
logMessage --message "The content of the variable \"numericValue\" is: ${numericValue}" --type "Info"
// Return the following output on the console:
// The content of the variable 'numericValue' is: 100

例 3: Windows イベント・ビューアーの「アプリケーション」ログに記録された「エラー」テキスト・メッセージを表示します。

logMessage --message "Execution occurred with errors and will be logged on the Windows Event Viewer." --type "Error" --logonwindows  --logname Application --source Application --eventid 2019
// Return the following output on the console:
// [Error] Execution has occurred with errors and will be logged on the Windows Event Viewer.
注: Message パラメーターの情報の配置に応じて、改行とスペーシングが考慮されます。