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

前の記事NetSuiteの始め方 | Understanding SuiteScript 2.x Modulesで、スクリプト実行の詳細を記録するために使用される NetSuiteの始め方 | N/log Module Overviewの SuiteScriptモジュールおよびN/logモジュールについて調査しました。次に、N/log: log.error(options)メソッドのメンバーの1つを詳しく確認します。

log.error(options)は、エラー重大度のメッセージをスクリプト実行ログに書き込みます。通常、スクリプトの実行に影響を与える可能性のある例外、障害またはクリティカルな問題を取得するために使用されます。

構文

require(['N/log'], function (log) {
    log.error(options);
});

パラメータ

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

• title (string、 required):ログに記録される内容を説明する短いラベル。
  • 最大長: 99文字
  • 省略、空またはnullに設定すると、NetSuiteに「無題」と表示されます。
• details (string | Object、 required):ログに記録されるメッセージまたはデータ。
  • 文字列、変数またはオブジェクトを含めることができます。
  • オブジェクトが渡された場合、NetSuiteはJSON.stringify()を使用して自動的に変換します。
  • 3,999文字を超えるメッセージは自動的に切り捨てられます。

サポートされているスクリプト・タイプ

log.error(options)メソッドは、クライアントとサーバーの両方のSuiteScriptタイプ(ユーザー・イベント、スケジュール済、Map/Reduce、Suiteletスクリプトなど)で使用できます。

ただし、重要な制限に注意してください。

• フォームに直接添付することによってデプロイされるクライアント・スクリプトは、N/logメソッドをサポートしていません。
• これらのフォーム・アタッチ・クライアント・スクリプトの場合は、かわりにconsole.log()を使用して、ブラウザの開発者コンソールにメッセージを表示します。

log.errorメソッドの使用例

/**
 * @NApiVersion 2 .x
 * @NScriptType ScheduledScript 
 */
define(['N/log'], function(log) {
// スクリプト・ロギング用のN/logモジュールをロード
    function execute(context) {
        try {
            // 'undefinedVariable'が定義されていないため、ReferenceErrorというエラーが発生する

            var broken = undefinedVariable + 1;
        } catch (e) {
            log.error({
                title: 'Intentional Error Example',
                details: e.message // This will log 'undefinedVariable is not defined'
            });
        }
    }

    return {
        execute: execute
    };
});

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