GlideImportSetTransformer - Scoped, Global

  • Release version: Yokohama
  • Updated January 30, 2025
  • 3 minutes to read

    • The GlideImportSetTransformer API provides methods to create an Import Set Transformer object used to execute an Import Set Transform.

    To execute an Import Set transform:
    1. Create an Import Set table using the GlideImportSetTable API.
    2. Create a Transform Map using the GlideImportSetTransformMap API.
    3. Create or use an existing Import Set using the GlideRecord API.
    4. Execute an Import Set Transform using the GlideImportSetTransformer API.
    Once you have created the Import Set record it must be consumed by the GlideImportSetTransformer API in order to trigger the transform.
    var transformer = new GlideImportSetTransformer();
transformer.transformAllMaps(importSetGr);

    GlideImportSetTransformer - GlideImportSetTransformer()

    Instantiates a GlideImportSetTransformer object.

    Table 1. Parameters
    Name Type Description
    None 
    var transformer = new GlideImportSetTransformer();

    GlideImportSetTransformer - getImportSetRun()

    Gets the Import Set Run object associated with a GlideImportSetTransformer object.

    Table 2. Parameters
    Name Type Description
    None
    Table 3. Returns
    Type Description
    GlideImportSetRun GlideImportSetRun object created by running a transformation or the argument supplied to the setImportSetRun() method. 
    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()

    Returns a Boolean value specifying whether or not there was an error during a transformation.

    Table 4. Parameters
    Name Type Description
    None
    Table 5. Returns
    Type Description
    Boolean Flag that indicates whether there is an error.
    • true: Error.
    • false: Success.
    		 
    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(String id)

    Associates an Import Set record with a specific GlideImportSetTransformer object.

    Table 6. Parameters
    Name Type Description
    id String The sys_id of an Import Set record from the Import Sets [sys_import_set] table.
    Table 7. Returns
    Type Description
    void 
    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)

    Associates an Import Set Run object with a specific GlideImportSetTransformer object.

    Table 8. Parameters
    Name Type Description
    importSetRun GlideImportSetRun GlideImportSetRun object representing the ImportSetRun record to track the transformation history.
    Table 9. Returns
    Type Description
    void 
    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)

    Associates a GlideImportLog object with a specific GlideImportSetTransformer object.

    If this method is not called prior to calling the transformAllMaps() method, a GlideImportLog object is created internally on the server side.

    Table 10. Parameters
    Name Type Description
    log GlideImportLog GlideImportLog object to link to the Import Set history. Once set, any call from the GlideImportLog object is associated with the Import Set run history for that specific transform.
    Table 11. Returns
    Type Description
    void 
    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(String mapID)

    Associates a Transform Map with a specific GlideImportSetTransformer object.

    Table 12. Parameters
    Name Type Description
    mapID String A sys_id from the Table Transform Maps [sys_transform_map] table.
    Table 13. Returns
    Type Description
    void 
    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(Boolean synchronous)

    Enables running synchronous transformations.

    Table 14. Parameters
    Name Type Description
    synchronous Boolean Sets transformation mode.

    Valid values:

    • true: Run transformation synchronously
    • false: Run transformation asynchronously

    Default: false
    Table 15. Returns
    Type Description
    void 
    
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, String rowSysId)

    Executes the Import Set transformation.

    Table 16. Parameters
    Name Type Description
    importSet GlideRecord GlideRecord of the import set to execute.
    rowSysId String Optional. Restricts transformation to a single record by passing the sys_id of a record from the Import Sets [sys_import_set] table.

    Default: Transform all rows
    Table 17. Returns
    Type Description
    void 
    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);