Server API reference › API reference › API implementation and reference
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:
- Create an Import Set table using the GlideImportSetTable API.
- Create a Transform Map using the GlideImportSetTransformMap API.
- Create or use an existing Import Set using the GlideRecord API.
- Execute an Import Set Transform using the GlideImportSetTransformer API.
Once you have created the Import Set record it must be consumed by the GlideImportSetTransformerAPI in order to trigger the transform.
var transformer = new GlideImportSetTransformer();
transformer.transformAllMaps(importSetGr);
Parent Topic:Server API reference
Related topics
GlideImportLog
GlideImportSetRun
GlideImportSetTable
GlideImportSetTransformMap
GlideRecord
GlideTransformLog
Instantiates a GlideImportSetTransformer object.
var transformer = new GlideImportSetTransformer();
Gets the Import Set Run object associated with a GlideImportSetTransformer object.
| 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();
Returns a Boolean value specifying whether or not there was an error during a transformation.
| 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');
}
Associates an Import Set record with a specific GlideImportSetTransformer object.
| Name | Type | Description |
|---|
| id | String | The sys_id of an Import Set record from the Import Sets [sys_import_set] table. |
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);
Associates an Import Set Run object with a specific GlideImportSetTransformer object.
| Name | Type | Description |
|---|
| importSetRun | GlideImportSetRun | GlideImportSetRun object representing the ImportSetRun record to track the transformation history. |
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);
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.
| 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. |
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);
Associates a Transform Map with a specific GlideImportSetTransformer object.
| Name | Type | Description |
|---|
| mapID | String | A sys_id from the Table Transform Maps [sys_transform_map] table. |
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);
Enables running synchronous transformations.
| Name | Type | Description |
|---|
| synchronous | Boolean | Sets transformation mode. Valid values: - true: Run transformation synchronously - false: Run transformation asynchronously Default: 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.setSyncImport(true);
transformer.transformAllMaps(importSet);
Executes the Import Set transformation.
| 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 |
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);