{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":804,"path":"api-reference/server-api-reference/GlideImportSetTransformerAPI.md","title":"GlideImportSetTransformer - Scoped, Global","bundle":null,"doc_type":null,"release":"australia","body":"\n# GlideImportSetTransformer - Scoped, Global\n\nThe GlideImportSetTransformer API provides methods to create an Import Set Transformer object used to execute an Import Set Transform.\n\nTo execute an Import Set transform:\n\n1.  Create an Import Set table using the GlideImportSetTable API.\n2.  Create a Transform Map using the GlideImportSetTransformMap API.\n3.  Create or use an existing Import Set using the GlideRecord API.\n4.  Execute an Import Set Transform using the GlideImportSetTransformer API.\n\nOnce you have created the Import Set record it must be consumed by the GlideImportSetTransformerAPI in order to trigger the transform.\n\n```\nvar transformer = new GlideImportSetTransformer();\ntransformer.transformAllMaps(importSetGr); \n```\n\n**Parent Topic:**[Server API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/api-server.md)\n\n**Related topics**  \n\n\n[GlideImportLog](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/GlideImportLogAPI.md)\n\n[GlideImportSetRun](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/GlideImportSetRunAPI.md)\n\n[GlideImportSetTable](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/GlideImportSetTableAPI.md)\n\n[GlideImportSetTransformMap](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/GlideImportSetTransformMapAPI.md)\n\n[GlideRecord](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/c_GlideRecordScopedAPI.md)\n\n[GlideTransformLog](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/GlideTransformLogAPI.md)\n\n## GlideImportSetTransformer - GlideImportSetTransformer\\(\\)\n\nInstantiates a GlideImportSetTransformer object.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n```\nvar transformer = new GlideImportSetTransformer();\n```\n\n## GlideImportSetTransformer - getImportSetRun\\(\\)\n\nGets the Import Set Run object associated with a GlideImportSetTransformer object.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n|Type|Description|\n|----|-----------|\n|GlideImportSetRun|GlideImportSetRun object created by running a transformation or the argument supplied to the setImportSetRun\\(\\) method.|\n\n```\nvar importSet = new GlideRecord('sys_import_set');\nimportSet.short_description = 'Import set from scripted rest api';\nimportSet.table_name = importSetTableName;\nvar importSetID = importSet.insert();\nvar transformer = new GlideImportSetTransformer();\ntransformer.transformAllMaps(importSet);\nvar importSetRun = transformer.getImportSetRun();\n\n```\n\n## GlideImportSetTransformer - isError\\(\\)\n\nReturns a Boolean value specifying whether or not there was an error during a transformation.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n<table id=\"table_jnr_wvq_xjb\" class=\"returns\"><thead><tr><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nBoolean\n\n</td><td>\n\nFlag that indicates whether there is an error.-   true: Error.\n-   false: Success.\n\n</td></tr></tbody>\n</table>```\nvar importSet = new GlideRecord('sys_import_set');\nimportSet.short_description = 'Import set from scripted rest api';\nimportSet.table_name = importSetTableName;\nvar importSetID = importSet.insert();\nvar transformer = new GlideImportSetTransformer();\ntransformer.transformAllMaps(importSet);\nif(transformer.isError()) {\n\tgs.error('Error executing the transform');\n}\n```\n\n## GlideImportSetTransformer - setImportSetID\\(String id\\)\n\nAssociates an Import Set record with a specific GlideImportSetTransformer object.\n\n|Name|Type|Description|\n|----|----|-----------|\n|id|String|The sys\\_id of an Import Set record from the Import Sets \\[sys\\_import\\_set\\] table.|\n\n|Type|Description|\n|----|-----------|\n|void| |\n\n```\nvar importSet = new GlideRecord('sys_import_set');\nimportSet.short_description = 'Import set from scripted rest api';\nimportSet.table_name = importSetTableName;\nvar importSetID = importSet.insert();\nvar transformer = new GlideImportSetTransformer();\ntransformer.setImportSetID(importSetID);\ntransformer.transformAllMaps(importSet);\n\n```\n\n## GlideImportSetTransformer - setImportSetRun\\(GlideImportSetRun importSetRun\\)\n\nAssociates an Import Set Run object with a specific GlideImportSetTransformer object.\n\n|Name|Type|Description|\n|----|----|-----------|\n|importSetRun|GlideImportSetRun|GlideImportSetRun object representing the ImportSetRun record to track the transformation history.|\n\n|Type|Description|\n|----|-----------|\n|void| |\n\n```\nvar importSet = new GlideRecord('sys_import_set');\nimportSet.short_description = 'Import set from scripted rest api';\nimportSet.table_name = importSetTableName;\nvar importSetID = importSet.insert();\nvar importSetRun = new GlideImportSetRun(importSetID);\nvar transformer = new GlideImportSetTransformer();\ntransformer.setImportSetRun(importSetRun);\ntransformer.transformAllMaps(importSet);\n\n```\n\n## GlideImportSetTransformer - setLogger\\(GlideImportLog log\\)\n\nAssociates a GlideImportLog object with a specific GlideImportSetTransformer object.\n\nIf this method is not called prior to calling the transformAllMaps\\(\\) method, a GlideImportLog object is created internally on the server side.\n\n|Name|Type|Description|\n|----|----|-----------|\n|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.|\n\n|Type|Description|\n|----|-----------|\n|void| |\n\n```\nvar importSet = new GlideRecord('sys_import_set');\nimportSet.short_description = 'Import set from scripted rest api';\nimportSet.table_name = importSetTableName;\nvar importSetID = importSet.insert();\nvar importLog = new GlideImportLog();\nvar transformer = new GlideImportSetTransformer();\ntransformer.setLogger(importLog);\ntransformer.transformAllMaps(importSet);\n\n```\n\n## GlideImportSetTransformer - setMapID\\(String mapID\\)\n\nAssociates a Transform Map with a specific GlideImportSetTransformer object.\n\n|Name|Type|Description|\n|----|----|-----------|\n|mapID|String|A sys\\_id from the Table Transform Maps \\[sys\\_transform\\_map\\] table.|\n\n|Type|Description|\n|----|-----------|\n|void| |\n\n```\nvar importSet = new GlideRecord('sys_import_set');\nimportSet.short_description = 'Import set from scripted rest api';\nimportSet.table_name = importSetTableName;\nvar importSetID = importSet.insert();\nvar transformMapId = '<sys id of transform map>';\nvar transformer = new GlideImportSetTransformer();\ntransformer.setMapID(transformMapId);\ntransformer.transformAllMaps(importSet);\n\n```\n\n## GlideImportSetTransformer - setSyncImport\\(Boolean synchronous\\)\n\nEnables running synchronous transformations.\n\n<table id=\"table_inr_wvq_xjb\" class=\"parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nsynchronous\n\n</td><td>\n\nBoolean\n\n</td><td>\n\nSets transformation mode. Valid values:\n\n -   true: Run transformation synchronously\n-   false: Run transformation asynchronously\n\n Default: false\n\n</td></tr></tbody>\n</table>|Type|Description|\n|----|-----------|\n|void| |\n\n```\n\nvar importSet = new GlideRecord('sys_import_set');\nimportSet.short_description = 'Import set from scripted rest api';\nimportSet.table_name = importSetTableName;\nvar importSetID = importSet.insert();\nvar transformer = new GlideImportSetTransformer();\ntransformer.setSyncImport(true);\ntransformer.transformAllMaps(importSet);\n\n```\n\n## GlideImportSetTransformer - transformAllMaps\\(GlideRecord importSet, String rowSysId\\)\n\nExecutes the Import Set transformation.\n\n<table id=\"table_inr_wvq_xjb\" class=\"parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nimportSet\n\n</td><td>\n\nGlideRecord\n\n</td><td>\n\nGlideRecord of the import set to execute.\n\n</td></tr><tr><td>\n\nrowSysId\n\n</td><td>\n\nString\n\n</td><td>\n\nOptional. 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\n\n</td></tr></tbody>\n</table>|Type|Description|\n|----|-----------|\n|void| |\n\n```\nvar importSet = new GlideRecord('sys_import_set');\nimportSet.short_description = 'Import set from scripted rest api';\nimportSet.table_name = importSetTableName;\nvar importSetID = importSet.insert();\nvar transformer = new GlideImportSetTransformer();\ntransformer.transformAllMaps(importSet);\n```\n\n"}}