The following sections describe the steps to install the ServiceNow connector for developer instances.

Code change on ServiceNow

1. Go to filter navigator and search for script includes.

   Select the Script Includes under System UI.

2. Filter the Name and search for propUtils.

3. Change the method UserGetSysId in the Script.

   Curent:

   UserGetSysId : function () {
   var opened_for;
   var user = new GlideRecord("sys_user");
   user.addQuery(this.getParameter('field'),this.getParameter('value'));
   user.query();
   if (user.next())
   opened_for=user.sys_id;
   var grInt = new GlideRecord('interaction');
   grInt.initialize();
   grInt.assigned_to= gs.getUserID();
   grInt.type= 'phone';
   grInt.opened_for= opened_for;
   var sysid=grInt.insert();
   return sysid;
   },

   New sample code for the incident:

   UserGetSysId : function () {
               var opened_for;
   
           //Incident related changes
                var sysidlist = {};
               var user = new GlideRecordSecure("sys_user");
                 user.addQuery(this.getParameter('field'),this.getParameter('value'));
                 user.query();
                 if(user.next()) {
                    opened_for=user.sys_id;//return user.sys_id;
                       var inc = new GlideRecordSecure('incident');
                               inc.addQuery('caller_id', opened_for);
                               inc.addQuery('state','IN','1,2');
                               inc.orderByDesc('sys_created_on');
                               inc.query();
                                   if (inc.next()) {
                                       sysidlist.incsysid=inc.getUniqueValue();
                                  }else{
                                       inc.initialize();
                                       inc.caller_id=opened_for;
                                       inc.contact_type='phone';
                                       inc.short_description='Call Received From '+ this.getParameter('value');
                                       sysidlist.incsysid=inc.insert();
                                   }
                 } 
               var grInt = new GlideRecordSecure('interaction');
                   grInt.initialize(); 
                   grInt.assigned_to= gs.getUserID(); 
                   grInt.type= 'phone'; 
                   grInt.opened_for= opened_for; 
               var sysid=grInt.insert();
               sysidlist.sysid=sysid;
               
               return JSON.stringify(sysidlist);
           },

1. Go to filter navigator and search for UI page.

   Select UI pages under System UI.

2. Filter the Name and search for agentdesktop.

3. Change the screenpop function in Client script.

   Current function:

   // screen pop
   function screenpop(callerani,callSessionInfo) {
   
   
   
   if(callerani===callSessionInfo.phoneNumber){
   callerani=stripPrefixes(callerani);
   }
   var gaout = new GlideAjax('propUtils');
   gaout.addParam('sysparm_name', 'UserGetSysId');
   gaout.addParam('field', 'phone');
   gaout.addParam('value', callerani);
   gaout.getXMLWait();
   
   
   var sysid = gaout.getAnswer();
     
   openFrameAPI.openServiceNowForm({
   entity: 'interaction',
   query: 'sys_id='+sysid
   });

   Sample code for the incident:

   // screen pop
   function screenpop(callerani,callSessionInfo) {
      
   
       if(callerani===callSessionInfo.phoneNumber){
           callerani=stripPrefixes(callerani);
       }
       
       var gaout = new GlideAjax('propUtils');
           gaout.addParam('sysparm_name', 'UserGetSysId');
           gaout.addParam('field', 'phone');
           gaout.addParam('value', callerani);
           gaout.getXMLWait();
   
   // For Incident-related change
         var sysObj = JSON.parse(gaout.getAnswer());
       
       if(sysObj.incsysid){
           openFrameAPI.openServiceNowForm({
           entity: 'incident',
           query: 'sys_id='+sysObj.incsysid, 
           'interaction_sys_id': sysObj.sysid  
          });
       }else{
           openFrameAPI.openServiceNowForm({
           entity: 'incident',
           query: 'sys_id=-1',
           'interaction_sys_id': sysObj.sysid //'a2ba0ba62fd121106446cc96f699b6b8'  
          });
       }
      
   }

If the caller information exists in CRM, and there is already a new incident opened with this contact, application opens the inprogress incident

If the caller information does not exist in CRM, the application opens a new incident

If the caller information exists in CRM, the application opens a new incident with prefilled details

Overview

This use case details the process to add an extra column to the ServiceNow table - webexcc_imp_activity and create sn_openframe_phone_log upon the installation of the Webex CC for ServiceNow CRM Connector.

By default, the table contains certain out of the box system fields and values.

You can create more business-specific variables (CAD Variables) inside of the WebexCC Flow designer and add the CAD variables inside of the ServiceNow post call activity log, as well as persist this to the post call activity table data.

Add Column to WebexCC IMP Activity

1. Edit the table in the developer version of ServiceNow.

   

2. Go to the filter navigator and search for studio.

   

   Select Webex Contact Center

   

   or

   

   

   

3. Select the WebexCC IMP Activity table

   

4. Add a new column, for example, CustomerName

   

   

Add Column to Phone Log

1. Edit the phone log table.

   

   

2. Add a new column, for example, CustomerName.

   

   

WebexCC Activity Transform Map

Add a new column, for example, CustomerName field mapping.

Personalize List Columns

As Service Now recommends, change the Choice action from create to ignore.

Configure phone logs list

Go to Script Include

See the line: webexcc.u_customername=actInfo.CustomerName; with a supporting comment.

var propUtils = Class.create();
propUtils.prototype = Object.extendsObject(global.AbstractAjaxProcessor,{
         getWebexccProp : function () {
           var webexccprop = {};
           webexccprop.instanceurl= 'https://'+gs.getProperty('instance_name')+'.service-now.com/';
           webexccprop.url=gs.getProperty('x_caci_webexcc.agentdesktop_url');
          // webexccprop.popupurl=gs.getProperty('x_caci_webexcc.screenpop_url');
           return  JSON.stringify(webexccprop);
      
        },
        UserGetSysId : function () {
            var opened_for;
            var user = new GlideRecord("sys_user");
              user.addQuery(this.getParameter('field'),this.getParameter('value'));
              user.query();
              if (user.next())
                 opened_for=user.sys_id;//return user.sys_id;
//            else
//               return null;
            var grInt = new GlideRecord('interaction');
                grInt.initialize();
                grInt.assigned_to= gs.getUserID();
                grInt.type= 'phone';
                grInt.opened_for= opened_for;
            var sysid=grInt.insert();
            return sysid;
        },
        setWebexcctable : function () {
            var sys_id=0;
             
            var actInfo = JSON.parse(this.getParameter('actInfo'));
            var webexcc = new GlideRecordSecure(gs.getProperty('x_caci_webexcc.webexccactivitytable'));
            webexcc.addQuery("callobject", actInfo.CallObject);
            webexcc.query();
            if(!webexcc.next()) {
                webexcc.ani = actInfo.ani;
                webexcc.dnis =actInfo.dnis;
                webexcc.queuename =actInfo.queuename;
                webexcc.wrapuptime =actInfo.wrapuptime;
                webexcc.callduration =actInfo.CallDurationInSeconds;
                webexcc.ringingtime =actInfo.ringingtime;
                webexcc.activitydate =actInfo.ActivityDate;
                webexcc.callobject =actInfo.CallObject;
                webexcc.calltype =actInfo.CallType;
                webexcc.calldisposition=actInfo.CallDisposition;
                 
                // This line is Added - to capture it in the Activity Log
               webexcc.u_customername=actInfo.CustomerName;
                 
                sys_id=webexcc.insert();
 
                //Activities on Incident record;
                var actInfoString =this.getParameter('actInfo');
                var suser = new GlideRecordSecure("sys_user");
                    suser.addQuery("phone", this.getParameter('ani'));
                    suser.query();
                    if(suser.next()) {
                    var inc = new GlideRecordSecure('incident');
                            inc.addQuery('caller_id', suser.sys_id);
                            inc.orderByDesc('sys_created_on');
                            inc.query();
                                if (inc.next()) {
                                    var jsonPretty = JSON.stringify(JSON.parse(actInfoString),null,2); 
                                    inc.comments =jsonPretty;
                                inc.update();
     
                            }
                    }
            }  
            return sys_id;
       },
 
    type: 'propUtils'
});

Create a CAD variable in Flow designer

Add the CAD variable to the Desktop Layout

Example

"CadName1:SnowField1,CadName2:SnowField2"
 CadName1 is CustomerName
 SnowField1 is also used as CustomerName which is part of sample scirpt showen above "actInfo.CustomerName".

Demo screenshots

View the newly added CAD variable in the WebexCC Activity table.

Create CAD variable for Flow Designer

Incident impact

Service Now script update

Updates to the Script Includes

1. Go to the filter navigator and search for script includes

   Select the Script Includes option under System UI.

   

2. Filter the Name with propUtils.

   

3. Change the method UserGetSysId in the Script field.

   

   Current script:

   UserGetSysId : function () {
   var opened_for;
   var user = new GlideRecord("sys_user");
   user.addQuery(this.getParameter('field'),this.getParameter('value'));
   user.query();
   if (user.next())
   opened_for=user.sys_id;
   var grInt = new GlideRecord('interaction');
   grInt.initialize();
   grInt.assigned_to= gs.getUserID();
   grInt.type= 'phone';
   grInt.opened_for= opened_for;
   var sysid=grInt.insert();
   return sysid;
   },

   New sample code for the incident:

   UserGetSysId : function () {
               var opened_for;
               
               var sysidlist = {};
               var user = new GlideRecordSecure("sys_user");
                 user.addQuery(this.getParameter('field'),this.getParameter('value'));
                 user.query();
                 if(user.next()) {
                    opened_for=user.sys_id;//return user.sys_id;
                       var inc = new GlideRecordSecure('incident');
                               inc.addQuery('caller_id', opened_for);
                               inc.addQuery('state','IN','1,2');
                               inc.orderByDesc('sys_created_on');
                               inc.query();
                                   if (inc.next()) {
                                       sysidlist.incsysid=inc.getUniqueValue();
                                  }else{
                                       inc.initialize();
                                       inc.caller_id=opened_for;
                                       inc.contact_type='phone';
                                       inc.urgency=this.getParameter('IncUrgency');
                                       inc.impact=this.getParameter('Impact');
                                       inc.short_description='Call Received From '+ this.getParameter('value');
                                       sysidlist.incsysid=inc.insert();
                                   }
                 } 
               var grInt = new GlideRecordSecure('interaction');
                   grInt.initialize(); 
                   grInt.assigned_to= gs.getUserID(); 
                   grInt.type= 'phone'; 
                   grInt.opened_for= opened_for; 
               var sysid=grInt.insert();
               sysidlist.sysid=sysid;
               
               return JSON.stringify(sysidlist);//sysid;
           },

1. Go to the filter navigator and search for UI pages.

   Select the UI Pages option under System UI.

   

2. Filter the UI Pages with Name and search for agentdesktop.

   

3. Change the screenpop function in the script field.

   

   Current function:

   // screen pop
   function screenpop(callerani,callSessionInfo) {
   
   
   if(callerani===callSessionInfo.phoneNumber){
   callerani=stripPrefixes(callerani);
   }
   var gaout = new GlideAjax('propUtils');
   gaout.addParam('sysparm_name', 'UserGetSysId');
   gaout.addParam('field', 'phone');
   gaout.addParam('value', callerani);
   gaout.getXMLWait();
   
   
   var sysid = gaout.getAnswer();
     
   openFrameAPI.openServiceNowForm({
   entity: 'interaction',
   query: 'sys_id='+sysid
   });
   
   }

   Sample code for the incident:

   // screen pop
   function screenpop(callerani,callSessionInfo) {
      
       var Impact=3;
       if(callSessionInfo.callAssociatedData.Impact != null && callSessionInfo.callAssociatedData.Impact != undefined)
       {
           Impact=callSessionInfo.callAssociatedData.Impact.value;
       }
       var IncUrgency=3;
       if(callSessionInfo.callAssociatedData.Urgency != null && callSessionInfo.callAssociatedData.Urgency != undefined)
       {
           IncUrgency=callSessionInfo.callAssociatedData.Urgency.value;
       }
       if(callerani===callSessionInfo.phoneNumber){
           callerani=stripPrefixes(callerani);
       }
       
       var gaout = new GlideAjax('propUtils');
           gaout.addParam('sysparm_name', 'UserGetSysId');
           gaout.addParam('field', 'phone');
           gaout.addParam('value', callerani);
           gaout.addParam('IncUrgency', IncUrgency);
           gaout.addParam('Impact', Impact);
           gaout.getXMLWait();
         // var sysid = gaout.getAnswer();
         var sysObj = JSON.parse(gaout.getAnswer());
       
       if(sysObj.incsysid){
           openFrameAPI.openServiceNowForm({
           entity: 'incident',
           query: 'sys_id='+sysObj.incsysid, 
           'interaction_sys_id': sysObj.sysid  
          });
       }else{
           openFrameAPI.openServiceNowForm({
           entity: 'incident',
           query: 'sys_id=-1',
           'interaction_sys_id': sysObj.sysid  
          });
       }
       window.localStorage.setItem("screenpopinteraction",JSON.stringify(sysObj));
      
   }

If the caller information exists in CRM, and there is no new or inprogress incident then the application opens a new incident

Change the code on ServiceNow

Add new columns to the WebexCC IMP Activity table

Click on Update.

Add new columns to the Phone Log table

Open the Phone Log table

WebexCC Activity Transform Map

Open transform map from the filter navigator

Click on WebexCC Activity TransformMap

Click Update.

Changes to Script Includes

1. Go to filter navigator and search for "script includes".

   Select the Script Includes under System UI.

   

2. Filter the Name with propUtils.

   

3. Change the method setWebexcctable.

   

   New sample code for Incident:

   setWebexcctable : function () {
               var sys_id=0;
               
               var actInfo = JSON.parse(this.getParameter('actInfo'));
               var webexcc = new GlideRecordSecure(gs.getProperty('webexccactivitytable'));
               webexcc.addQuery("u_callobject", actInfo.CallObject);
               webexcc.query();
               if(!webexcc.next()) {
                   
                   //Activities on Incident record;
                   //var actInfoString =this.getParameter('actInfo');
                   var incsysid=actInfo.incident_sys_id;
                   var interactionsysid=actInfo.interaction_sys_id;
                   var incnum="";
                   var intenum="";
                   delete actInfo['interaction_sys_id'];
                   delete actInfo['incident_sys_id'];
                   if( interactionsysid!= null && interactionsysid != undefined){
                       var inte = new GlideRecordSecure('interaction');
                       //inte.get('sys_id', interactionsysid );
                       
                       inte.addQuery('sys_id', interactionsysid );
                       inte.query();
                       if (inte.next()) {
                           intenum=inte.number;
                          // inte.setValue('state','Closed Complete');
                           inte.work_notes='Update State to closed.';
                           inte.update();
       
                       }
                   }
                   if( incsysid!= null && incsysid != undefined){
                       var inci = new GlideRecordSecure('incident');
                       inci.addQuery('sys_id', incsysid );
                       inci.query();
                       if (inci.next()) {
                           incnum=inci.number;
                           var jsonPretty = JSON.stringify(actInfo,null,2); //JSON.stringify(JSON.parse(actInfoString),null,2);  
                           inci.comments =jsonPretty;
                           inci.update();
       
                       }
                   }else{
                     var suser = new GlideRecordSecure("sys_user");
                       suser.addQuery("phone", this.getParameter('ani'));
                       suser.query();
                       if(suser.next()) {
                       var inc = new GlideRecordSecure('incident');
                               inc.addQuery('caller_id', suser.sys_id);
                               inc.addQuery('state','IN','1,2');
                               inc.orderByDesc('sys_created_on');
                               inc.query();
                                   if (inc.next()) {
                                       var jsonPretty = JSON.stringify(actInfo,null,2);  
                                       inc.comments =jsonPretty;
                                   inc.update();
       
                               }
                       } 
                   }
                  
                   
                   webexcc.u_ani = actInfo.ani;
                   webexcc.u_dnis =actInfo.dnis;
                   webexcc.u_queuename =actInfo.queuename;
                   webexcc.u_wrapuptime =actInfo.wrapuptime;
                   webexcc.u_callduration =actInfo.CallDurationInSeconds;
                   webexcc.u_ringingtime =actInfo.ringingtime;
                   webexcc.u_activitydate =actInfo.ActivityDate;
                   webexcc.u_callobject =actInfo.CallObject;
                   webexcc.u_calltype =actInfo.CallType;
                   webexcc.u_calldisposition=actInfo.CallDisposition;
                   webexcc.u_incidentnumber=incnum;
                   webexcc.u_interactionsnumber=intenum;
                   sys_id=webexcc.insert();
   
                   
                               
               }    
               return sys_id;
          },

Method changes on UI pages

1. Go to filter navigator and search for UI pages

   Select the UI Pages option under System UI.

   

2. Filter the UI Pages with Name and search for agentdesktop.

   

3. Change the nowActivities and screenpop function in the script.

   

   Current function:

   function nowActivities(actInfo, ani) {
       
       var gaout = new GlideAjax('propUtils');
       gaout.addParam('sysparm_name', 'setWebexcctable');
       gaout.addParam('actInfo', JSON.stringify(actInfo));
       gaout.addParam('ani', stripPrefixes(ani));
       gaout.getXML(SetCCsysId);
   
   
   }

   Sample code for the incident:

   function nowActivities(actInfo, ani) {
       var sysObjstr = window.localStorage.getItem("screenpopinteraction");
       if(sysObjstr != null && sysObjstr != undefined)
       {
           var sysObjjson=JSON.parse(sysObjstr);
           actInfo.interaction_sys_id=sysObjjson.sysid;
           actInfo.incident_sys_id=sysObjjson.incsysid;
       }
       var gaout = new GlideAjax('propUtils');
       gaout.addParam('sysparm_name', 'setWebexcctable');
       gaout.addParam('actInfo', JSON.stringify(actInfo));
       gaout.addParam('ani', stripPrefixes(ani));
       gaout.getXML(SetCCsysId);
   
   
   }
   
   function screenpop(callerani,callSessionInfo) {
      
   
       if(callerani===callSessionInfo.phoneNumber){
           callerani=stripPrefixes(callerani);
       }
       
       var gaout = new GlideAjax('propUtils');
           gaout.addParam('sysparm_name', 'UserGetSysId');
           gaout.addParam('field', 'phone');
           gaout.addParam('value', callerani);
           gaout.getXMLWait();
         // var sysid = gaout.getAnswer();
         var sysObj = JSON.parse(gaout.getAnswer());
       
       if(sysObj.incsysid){
           openFrameAPI.openServiceNowForm({
           entity: 'incident',
           query: 'sys_id='+sysObj.incsysid, 
           'interaction_sys_id': sysObj.sysid  
          });
       }else{
           openFrameAPI.openServiceNowForm({
           entity: 'incident',
           query: 'sys_id=-1',
           'interaction_sys_id': sysObj.sysid  
          });
       }
       window.localStorage.setItem("screenpopinteraction",JSON.stringify(sysObj));
           
      
   }
   
   

Results after the update

Customization # 1 - Add custom business rules for call flow use cases

For every new call into the WebexCC CRM connector in ServiceNow, create a New Incident Record.

1. Search for Business Rules on the Filter navigator

   

2. Click New.

   

   Sample code for reference:

   function customcti() {
               var url = null;
               var name = sysparm_caller_name;
               eid = sysparm_caller_id;
               var phone = sysparm_caller_phone;
               var taskID = sysparm_task_id;
               var fQuery = sysparm_query;
               if (fQuery == null)
                  fQuery = '';
               var view = sysparm_view;
               if (view == null || view == '')
                   view = "itil";
    
               var userID = null;
               if (eid != null && eid != '') {
                   userID = UserGetSysId("employee_number",eid);
               }
               if (userID == null && name != null && name != '') {
                   userID = UserGetSysId("name", name);                
               }
               if (userID == null && phone != null && phone != '') {
                   userID = UserGetSysId("phone", phone);
               }
    
               if (userID != null) {
                   if (fQuery.length > 0)
                       fQuery += "^";
                   fQuery += "caller_id=" + userID;
               }
               if (url == null) {
                   url = "incident.do?sys_id=-1";
                   if (fQuery != null)
                      url += "&sysparm_query=" + fQuery;
               }
               answer = url;
               return url;
   }
    
   function UserGetSysId(field, value) {
     var user = new GlideRecord("sys_user");
     user.addQuery(field, value);
     user.query();
     if (user.next())
        return user.sys_id;
     else
        return null;
   }

   Sample configuration of the business rule

   

3. Enable Client callable

   

   Computer Telephony Integration (CTI) Processing For Incident is marked as True.

   

4. Update the screenpop url with the custom CTI Rule " cti.do?sysparm_cti_rule=createIncident&sysparm_caller_phone="

   

The sysparm_cti_rule=name where 'name' is the name of a function is to be invoked for CTI Processing rather than using the default script.

Define the function in a sys_script entry marked client callable.

If you must insert, update, or delete any GlideRecord(s) in the function, call a separate nonclient callable function to perform the updates.

• https://docs.servicenow.com/en-US/bundle/tokyo-application-development/page/script/business-rules/concept/c_BusinessRules.html

• https://docs.servicenow.com/bundle/tokyo-platform-administration/page/integrate/incident/reference/r_ComputerTelephonyIntegration.html

Customization # 2 - Add CAD variable in Webex Contact Center activity table

This article details the process to add an additional column to the ServiceNow table - webexcc_activity that is created upon the installation of the Webex CC for ServiceNow CRM Connector.

By default, the table contains out-of-box system fields and values.

You can potentially create more business-specific variables (CAD Variables) inside the WebexCC Flow designer and add those CAD variables inside the ServiceNow post call activity log, and persist this to the post call activity table data.

1. Edit the table in the developer version of ServiceNow.

   

2. Go to the Studio > Webex Contact Center.

   

   

   

3. Select WebexCC Activity table.

   

4. For example, CustomerName.

   

   

5. Select List Layout for WebexCC Activity.

   

Sample script

See the line with:webexcc.u_customername=actInfo.CustomerName; with a supporting comment.

var propUtils2 = Class.create();
propUtils2.prototype = Object.extendsObject(global.AbstractAjaxProcessor,{
         getWebexccProp : function () {
           var webexccprop = {};
           webexccprop.instanceurl= 'https://'+gs.getProperty('instance_name')+'.service-now.com/';
           webexccprop.url=gs.getProperty('x_caci_webexcc.agentdesktop_url');
           webexccprop.popupurl=gs.getProperty('x_caci_webexcc.screenpop_url');
           return  JSON.stringify(webexccprop);
      
        },
        setWebexcctable : function () {
            var sys_id=0;
             
            var actInfo = JSON.parse(this.getParameter('actInfo'));
            var webexcc = new GlideRecordSecure(gs.getProperty('x_caci_webexcc.webexccactivitytable'));
            webexcc.addQuery("callobject", actInfo.CallObject);
            webexcc.query();
            if(!webexcc.next()) {
                webexcc.ani = actInfo.ani;
                webexcc.dnis =actInfo.dnis; 
                webexcc.queuename =actInfo.queuename;
                webexcc.wrapuptime =actInfo.wrapuptime;
                webexcc.callduration =actInfo.CallDurationInSeconds;
                webexcc.ringingtime =actInfo.ringingtime;
                webexcc.activitydate =actInfo.ActivityDate;
                webexcc.callobject =actInfo.CallObject;
                webexcc.calltype =actInfo.CallType;
                webexcc.calldisposition=actInfo.CallDisposition;
 
               // This line is Added - to capture it in the Activity Log
               webexcc.u_customername=actInfo.CustomerName;
 
                sys_id=webexcc.insert();
  
                // Activities on Incident record;
                var actInfoString =this.getParameter('actInfo');
                var suser = new GlideRecordSecure("sys_user");
                    suser.addQuery("phone", this.getParameter('ani'));
                    suser.query();
                    if(suser.next()) {
                    var inc = new GlideRecordSecure('incident');
                            inc.addQuery('caller_id', suser.sys_id);
                            inc.orderByDesc('sys_created_on');
                            inc.query();
                                if (inc.next()) {
                                    var jsonPretty = JSON.stringify(JSON.parse(acting string),null,2);  
                                    inc.comments =jsonPretty;
                                inc.update();
                                 }
                    } 
            }    
            return sys_id;
       },
 
    type: 'propUtils2'
});

Create a CAD variable in Flow designer

Add the CAD variable to the Desktop Layout

Demo screenshots

View the newly added CAD variable in the WebexCC Activity table.