GlideImportSetTransformer - スコープ対象、グローバル

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：9分

    • GlideImportSetTransformer API は、インポートセット変換の実行に使用されるインポートセットトランスフォーマーオブジェクトを作成するメソッドを提供します。

    インポートセット変換を実行するには：
    1. GlideImportSetTable API を使用してインポートセットテーブルを作成します。
    2. GlideImportSetTransformMap API を使用して変換マップを作成します。
    3. GlideRecord API を使用してインポートセットを作成するか既存のインポートセットを使用します。
    4. GlideImportSetTransformer API を使用してインポートセット変換を実行します。
    インポートセットレコードを作成したら、変換をトリガーするために GlideImportSetTransformer API でそのレコードを使用する必要があります。
    var transformer = new GlideImportSetTransformer();
transformer.transformAllMaps(importSetGr);

    GlideImportSetTransformer - GlideImportSetTransformer()

    GlideImportSetTransformer オブジェクトをインスタンス化します。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし 
    var transformer = new GlideImportSetTransformer();

    GlideImportSetTransformer - getImportSetRun()

    GlideImportSetTransformer オブジェクトに関連付けられたインポートセット実行オブジェクトを取得します。

    表 : 2. パラメーター
    名前 タイプ 説明
    なし
    表 : 3. 返される内容
    タイプ 説明
    GlideImportSetRun 変換を実行することによって作成された GlideImportSetRun オブジェクト、または setImportSetRun() メソッドに指定された引数。 
    var importSet = new GlideRecord('sys_import_set');
importSet.short_description = 'Import set from scripted rest api';
importSet.table_name = importSetTableName;
var importSetID = importSet.insert();
var transformer = new GlideImportSetTransformer();
transformer.transformAllMaps(importSet);
var importSetRun = transformer.getImportSetRun();

    GlideImportSetTransformer - isError()

    変換中にエラーが発生したかどうかを指定するブーリアン値を返します。

    表 : 4. パラメーター
    名前 タイプ 説明
    なし
    表 : 5. 返される内容
    タイプ 説明
    ブーリアン エラーがあるかどうかを示すフラグ。
    • true：エラー。
    • false：成功。
    		 
    var importSet = new GlideRecord('sys_import_set');
importSet.short_description = 'Import set from scripted rest api';
importSet.table_name = importSetTableName;
var importSetID = importSet.insert();
var transformer = new GlideImportSetTransformer();
transformer.transformAllMaps(importSet);
if(transformer.isError()) {
	gs.error('Error executing the transform');
}

    GlideImportSetTransformer - setImportSetID(文字列 id)

    インポートセットレコードを特定の GlideImportSetTransformer オブジェクトに関連付けます。

    表 : 6. パラメーター
    名前 タイプ 説明
    ID 文字列 インポートセット [sys_import_set] テーブルからのインポートセットレコードの sys_id。
    表 : 7. 返される内容
    タイプ 説明
    なし 
    var importSet = new GlideRecord('sys_import_set');
importSet.short_description = 'Import set from scripted rest api';
importSet.table_name = importSetTableName;
var importSetID = importSet.insert();
var transformer = new GlideImportSetTransformer();
transformer.setImportSetID(importSetID);
transformer.transformAllMaps(importSet);

    GlideImportSetTransformer - setImportSetRun(GlideImportSetRun importSetRun)

    インポートセット実行オブジェクトを特定の GlideImportSetTransformer オブジェクトに関連付けます。

    表 : 8. パラメーター
    名前 タイプ 説明
    importSetRun GlideImportSetRun 変換履歴を追跡する ImportSetRun レコードを表す GlideImportSetRun オブジェクト。
    表 : 9. 返される内容
    タイプ 説明
    なし 
    var importSet = new GlideRecord('sys_import_set');
importSet.short_description = 'Import set from scripted rest api';
importSet.table_name = importSetTableName;
var importSetID = importSet.insert();
var importSetRun = new GlideImportSetRun(importSetID);
var transformer = new GlideImportSetTransformer();
transformer.setImportSetRun(importSetRun);
transformer.transformAllMaps(importSet);

    GlideImportSetTransformer - setLogger(GlideImportLog log)

    GlideImportLog オブジェクトを特定の GlideImportSetTransformer オブジェクトに関連付けます。

    transformAllMaps() メソッドを呼び出す前にこのメソッドを呼び出さないと、サーバー側で GlideImportLog オブジェクトが内部的に作成されます。

    表 : 10. パラメーター
    名前 タイプ 説明
    log GlideImportLog インポートセット履歴にリンクする GlideImportLog オブジェクト。設定すると、GlideImportLog オブジェクトからの呼び出しがその特定の変換のインポートセット実行履歴に関連付けられます。
    表 : 11. 返される内容
    タイプ 説明
    なし 
    var importSet = new GlideRecord('sys_import_set');
importSet.short_description = 'Import set from scripted rest api';
importSet.table_name = importSetTableName;
var importSetID = importSet.insert();
var importLog = new GlideImportLog();
var transformer = new GlideImportSetTransformer();
transformer.setLogger(importLog);
transformer.transformAllMaps(importSet);

    GlideImportSetTransformer - setMapID(文字列 mapID)

    変換マップを特定の GlideImportSetTransformer オブジェクトに関連付けます。

    表 : 12. パラメーター
    名前 タイプ 説明
    mapID 文字列 テーブル変換マップ [sys_transform_map] テーブルの sys_id。
    表 : 13. 返される内容
    タイプ 説明
    なし 
    var importSet = new GlideRecord('sys_import_set');
importSet.short_description = 'Import set from scripted rest api';
importSet.table_name = importSetTableName;
var importSetID = importSet.insert();
var transformMapId = '<sys id of transform map>';
var transformer = new GlideImportSetTransformer();
transformer.setMapID(transformMapId);
transformer.transformAllMaps(importSet);

    GlideImportSetTransformer - setSyncImport(ブーリアン synchronous)

    同期変換の実行を有効にします。

    表 : 14. パラメーター
    名前 タイプ 説明
    synchronous ブーリアン 変換モードを設定します。

    有効な値：

    • true：変換を同期的に実行
    • false：変換を非同期的に実行

    デフォルト値：false
    表 : 15. 返される内容
    タイプ 説明
    なし 
    
var importSet = new GlideRecord('sys_import_set');
importSet.short_description = 'Import set from scripted rest api';
importSet.table_name = importSetTableName;
var importSetID = importSet.insert();
var transformer = new GlideImportSetTransformer();
transformer.setSyncImport(true);
transformer.transformAllMaps(importSet);

    GlideImportSetTransformer - transformAllMaps(GlideRecord importSet, 文字列 rowSysId)

    インポートセット変換を実行します。

    表 : 16. パラメーター
    名前 タイプ 説明
    importSet GlideRecord 実行するインポートセットの GlideRecord。
    rowSysId 文字列 オプション。インポートセット [sys_import_set] テーブルからレコードの sys_id を渡して、変換を 1 つのレコードに制限します。

    デフォルト：すべての行を変換
    表 : 17. 返される内容
    タイプ 説明
    なし 
    var importSet = new GlideRecord('sys_import_set');
importSet.short_description = 'Import set from scripted rest api';
importSet.table_name = importSetTableName;
var importSetID = importSet.insert();
var transformer = new GlideImportSetTransformer();
transformer.transformAllMaps(importSet);