How to move catalog item completely from one instance to other instance along with variables, Variable sets, client scripts, Ui policies.

Dinesh Kumar11 · ‎01-17-2020

The first step is to set up a 'Processor' record to handle the export. & UI action to call the processor.

There are 2 ways to set up the processor & Ui action.

1. You can try importing the attached update set file through retrieved update sets into your instance to export catalog item from one instance to other.

After that you will find in UI Actions : Export Catalog Item

and Processor in left Navigation -> ExportCatalogItem .

OR

2. Create a Processor & UI action manually.

Here's how you would set up a processor for the catalog item export.

Type "processor" in the left navigator and select system definition >> processor

Name: ExportCatalogItem
Type: Script
Path: export_catalog_item
Script:

(function process(g_request, g_response, g_processor) {
    var sysid = g_request.getParameter('sysparm_sys_id');
    gs.log('** Exporting Catalog Item ' + sysid);

    //Name all the related lists
    var exporter = new ExportWithRelatedLists('sc_cat_item', sysid);
    exporter.addRelatedList('item_option_new', 'cat_item');
    exporter.addRelatedList('catalog_script_client', 'cat_item');
    exporter.addRelatedList('catalog_ui_policy', 'catalog_item');
    exporter.addRelatedList('sc_cat_item_category', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_catalog', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_user_criteria_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_user_criteria_no_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_group_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_group_no_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_company_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_company_no_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_dept_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_dept_no_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_location_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_location_no_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_user_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_user_no_mtom', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_app_group', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_app_user', 'sc_cat_item');
    exporter.addRelatedList('sc_cat_item_guide_items', 'guide');
    exporter.addRelatedList('pc_vendor_cat_item', 'product_catalog_item');

    var catalogID = '';
    var categoryID = '';
    var vsrelID = '';
    var vsID = '';
    var vID = '';
    var qcID = '';
    var uipID = '';
    var actID = '';
    var csID = '';

    //Query for Catalogs
    var catalog = new GlideRecord('sc_cat_item_catalog');
    catalog.addQuery('sc_cat_item', sysid);
    catalog.query();
    while(catalog.next()){
        //Get Catalog IDs
        catalogID = catalogID + ',' + catalog.sc_catalog.sys_id.toString();
    }

    //Query for Categories
    var category = new GlideRecord('sc_cat_item_category');
    category.addQuery('sc_cat_item', sysid);
    category.query();
    while(category.next()){
        //Get Category IDs
        categoryID = categoryID + ',' + category.sc_category.sys_id.toString();
    }

    //Query for variables to get question choices
    var item = new GlideRecord('item_option_new');
    item.addQuery('cat_item', sysid);
    item.query();
    while(item.next()){
        //Query for question choices
        var qc = new GlideRecord('question_choice');
        qc.addQuery('question', item.sys_id.toString());
        qc.query();
        while(qc.next()){
            //Add the variable question sys_id to the variable question string
            qcID = qcID + ',' + qc.sys_id.toString();
        }
    }

    //Query for ui catalog ui policies to get policy actions
    var catpol = new GlideRecord('catalog_ui_policy');
    catpol.addQuery('catalog_item', sysid);
    catpol.query();
    while(catpol.next()){
        //Query for ui policy actions
        var uipact = new GlideRecord('catalog_ui_policy_action');
        uipact.addQuery('ui_policy', catpol.sys_id.toString());
        uipact.query();
        while(uipact.next()){
            //Add the ui policy action sys_id to the ui policy action string
            actID = actID + ',' + uipact.sys_id.toString();
        }
    }

    //Query for variable set relationships
    var vsrel = new GlideRecord('io_set_item');
    vsrel.addQuery('sc_cat_item', sysid);
    vsrel.query();
    while(vsrel.next()){
        //Add the item set relationship sys_id to the item set string
        vsrelID = vsrelID + ',' + vsrel.sys_id.toString();
        //Get the variable set
        var vs = vsrel.variable_set.getRefRecord();
        if(vs){
            //Add the variable set sys_id to the variable set string
            vsID = vsID + ',' + vs.sys_id.toString();
            //Query for variables in the set
            var v = new GlideRecord('item_option_new');
            v.addQuery('variable_set', vs.sys_id);
            v.query();
            while(v.next()){
                //Add the variable sys_id to the variable string
                vID = vID + ',' + v.sys_id.toString();
                //Query for variable question choices
                var vqc = new GlideRecord('question_choice');
                vqc.addQuery('question', v.sys_id.toString());
                vqc.query();
                while(vqc.next()){
                    //Add the variable question sys_id to the variable question string
                    qcID = qcID + ',' + vqc.sys_id.toString();
                }
            }

            //Query for ui policies in the set
            var uip = new GlideRecord('catalog_ui_policy');
            uip.addQuery('variable_set', vs.sys_id.toString());
            uip.query();
            while(uip.next()){
                //Add the ui policy sys_id to the ui policy string
                uipID = uipID + ',' + uip.sys_id.toString();
                //Query for ui policy actions
                var uipa = new GlideRecord('catalog_ui_policy_action');
                uipa.addQuery('ui_policy', uip.sys_id.toString());
                uipa.query();
                while(uipa.next()){
                    //Add the ui policy action sys_id to the ui policy action string
                    actID = actID + ',' + uipa.sys_id.toString();
                }
            }

            //Query for client scripts in the set
            var cs = new GlideRecord('catalog_script_client');
            cs.addQuery('variable_set', vs.sys_id.toString());
            cs.query();
            while(cs.next()){
                //Add the client script sys_id to the client script string
                csID = csID + ',' + cs.sys_id.toString();
            }
        }
    }

    exporter.addQuerySet('sc_catalog', 'sys_idIN' + catalogID);
    exporter.addQuerySet('sc_category', 'sys_idIN' + categoryID);
    exporter.addQuerySet('io_set_item', 'sys_idIN' + vsrelID);
    exporter.addQuerySet('item_option_new_set', 'sys_idIN' + vsID);
    exporter.addQuerySet('item_option_new', 'sys_idIN' + vID);
    exporter.addQuerySet('question_choice', 'sys_idIN' + qcID);
    exporter.addQuerySet('catalog_ui_policy', 'sys_idIN' + uipID);
    exporter.addQuerySet('catalog_ui_policy_action', 'sys_idIN' + actID);
    exporter.addQuerySet('catalog_script_client', 'sys_idIN' + csID);
    exporter.exportRecords(g_response);
})(g_request, g_response, g_processor);

Once done create a 'Export Catalog Item' UI Action

Name: Export Catalog Item
Table: Catalog Item (sc_cat_item)
Order: 200
Form link: True
Show insert: False
Show update: True
Client True
Hint: Export catalog item definition to .xml file
Onclick callExportCatalogItem();
Condition: gs.hasRole('admin')
Script:

function callExportCatalogItem() {
   var url = new GlideURL('export_catalog_item.do');
   url.addParam('sysparm_sys_id', gel("sys_uniqueValue").value);
   var frame = top.gsft_main;
   if (!frame){
      frame = top;
   }

   frame.location = url.getURL(); 
}

Once you’re done with this, you should have an ‘Export Catalog Item’ UI action context menu item on your ‘Catalog Item’ forms that you can use to transport catalog items, record producers, and order guides in the event that they don’t get captured in an update set.

Reference from KB Article : Number: KB0756660 .

Mark ✅ Correct if this 👍 Helpful.

Regards,

RDK.

choudhuryfa · ‎10-15-2020

Not working for me on Orlando. Customer has deleted out of the box record producers and i need to recover them with sysID. Not showing in deleted records. I am trying to export from a dev instance to customer instance.

Lynette Sandlin · ‎12-16-2020

This worked great for me (on Paris) and will save me a lot of time. We are moving to an entirely different instance of ServiceNow and have about 60 items that need to be moved over on a very short deadline with only myself to work it. THANK YOU!

Rafal Rataj1 · ‎04-07-2021

I am getting an error on
glide-orlando-12-11-2019__patch10-hotfix2-02-26-2021

Uncaught TypeError: gel is not a function

Dinesh Kumar11 · ‎07-14-2021

Hi Rafal Rataj ,

I have attached My update set too , can you please import update set to your instance and try to check this functionality. This will work definitely as I tried in my instance.

Regards,

Dinesh Kumar Raghu.

anupamg · ‎09-07-2021

This looks great ! Thanks for sharing the scripts.

Quick question, I do not see attached workflow being copied , am I missing something ?

Thanks

Anupam

Dinesh Kumar11 · ‎10-22-2021

Workflows you should import separately by using xml , later it will attach automatically to catalog item by checking sysid of workflow. Please hit helpfull , let me know if you have questions on this ... Thank you Dinesh Kumar

Sriram29 · ‎08-24-2022

Can you help me on how you move all the items. I tried but the above process is not working.

Matt184 · ‎12-01-2022

Hello! This looks amazing but I'm having trouble with how to import it into another instance of ServiceNow. I thought to use the Update Set Import but when I do that, it's not in my list. Is there another process to utilize the XML that this creates? Thank you for the insight!

Matt

Andy Newman · ‎08-22-2023

Worked perfectly for my catalog item move - thank you so much for this.