NetSuite の始め方 | N/log: log.audit(options)メソッド

前の記事NetSuiteの始め方 | SuiteScript 2.xモジュールの理解で、スクリプト実行の詳細を記録するために使用されるSuiteScriptモジュールおよびN/logモジュール(NetSuiteの始め方 | N/logモジュールの概要)を学習しました。次に、N/log: log.audit(options) Methodのメンバーの1つを詳しく確認します。

log.audit(options)メソッドを使用すると、監査レベルのログ・エントリをスクリプト実行ログに書き込むことができます。監査レベルのログは、スクリプトの実行に関する重要な高レベルの情報を記録するために使用され、重要なイベントやマイルストンの追跡に役立ちます。

これらのメッセージは、開発者がキー・イベント、検証またはチェックポイント(特に、過剰なロギングを回避する必要がある本番環境)を追跡するのに役立ちます。監査ログは、デプロイメントの「ログ・レベル」が「監査」または「デバッグ」に設定されているかぎり、スクリプト・デプロイメントの「実行ログ」サブタブに表示されます。

構文

log.audit(オプション)

パラメータ

options (Object) - 次の必須プロパティを持つオブジェクト。

• title (文字列)
  • 実行ログの「タイトル」列に表示されるログ・エントリのタイトル。
  • 最大長: 99文字
  • null、'または省略した場合は、"Untitled"が自動的に使用されます
• details (文字列またはオブジェクト)
  • ログに記録する詳細なメッセージまたは情報。
  • 任意の値を受け入れます。
  • JavaScriptオブジェクトが渡されると、JSON.stringify()を使用して自動的に変換されます。
  • 3999文字を超える値を切り捨てます。

例:定期スクリプトでのlog.audit()の使用

/**
 * @NApiVersion 2 .x
 * @NScriptType ScheduledScript 
 */
define(['N/log'], function(log) {
    
    function execute(context) {
        // スクリプト実行の開始を示す監査ログ
        log.audit({
            title: 'Scheduled Script Execution Started',
            details: 'The scheduled script has started running.'
        });
        //ここにメインのスクリプトロジックを挿入することができます
        //正常終了を示す監査ログ
        log.audit({
            title: 'Scheduled Script Execution Completed',
            details: 'The scheduled script has finished running.'
        });
    }
    return {
        execute: execute
    };
});

• スクリプトは、log.audit()を使用して、定期スクリプトの実行の開始と完了を記録します。
• 「//ここにメイン・スクリプト・ロジックを挿入できます」セクションを、実際の定期スクリプト・コード・ロジックに置き換えます。

ここに記載されているサンプルコードは、法律で許可される最大限の範囲で、いかなる種類の保証もなく「現状のまま」提供されます。Oracle + NetSuite Inc. は、サンプルコードの開発プラットフォームへの実装や、独自のWebサーバー構成の使用において、開発者の個々の成功を保証または保証しません。

Oracle + NetSuite Inc. は、サンプルコードに関連するデータまたは情報の使用、使用結果、正確性、適時性、完全性に関して、いかなる保証も行わず、すべての保証（明示的または黙示的）を否認します。特に、商品性、特定の目的への適合性、コードに関連するサービスまたはソフトウェアに関する保証を否認します。

Oracle + NetSuite Inc. は、サンプルコードに関連する行動から生じるいかなる種類の直接的、間接的または結果的な損害や費用についても責任を負いません。

SuiteScriptのデプロイの詳細は、これらのNetSuiteの始め方記事を確認してください。 

• NetSuite の始め方 | スクリプトレコードの作成方法
• NetSuite の始め方 | SuiteScript 2.x レコードでスクリプトタイプを設定する方法
• NetSuite の始め方 | スクリプトレコードの展開方法
• NetSuiteの始め方 | SuiteScript の種類の概要

今後の記事では、個々のSuiteScript 2.xモジュール