“I think it is often easier to make progress on mega-ambitious dreams. Since no one else is crazy enough to do it, you have little competition.”
— Larry Page
Last time, we wrapped up all of the code in the shared functions to include the logo images whenever an instance or application is transferred from one instance to another. Now we need to take a look at those places where the shared functions are not currently being used and replace the code in those existing functions with calls to the shared functions. This will not only consolidate the code and ensure that the logo images will be included, but since we also added a logging feature to the shared functions, it will also ensure that the REST API activity gets recorded.
Our ApplicationPublisher Script Include contains individual functions for the 7 independent phases of the application publishing process. The first four are all internal, but the last three move the artifacts from the Client instance to the the Host, so we will want to rework each one of those. Before we do that, though, we will want to snag the image from the sys_app record and attach it to our application record, which is something that we can do in Phase 2, once the application record is available. We can insert a line into this code:
mbrAppGR.setValue('name', sysAppGR.getValue('name'));
mbrAppGR.setValue('scope', sysAppGR.getValue('scope'));
mbrAppGR.setValue('description', sysAppGR.getValue('short_description'));
mbrAppGR.setValue('current_version', sysAppGR.getValue('version'));
mbrAppGR.setValue('active', true);
mbrAppGR.update();
… and make it look like this:
mbrAppGR.setValue('name', sysAppGR.getValue('name'));
mbrAppGR.setValue('scope', sysAppGR.getValue('scope'));
mbrAppGR.setValue('description', sysAppGR.getValue('short_description'));
mbrAppGR.setValue('current_version', sysAppGR.getValue('version'));
mbrAppGR.setValue('active', true);
if (sysAppGR.getValue('logo') && !mbrAppGR.getValue('logo')) {
mbrAppGR.setValue('logo', this.copyLogoImage(answer));
}
mbrAppGR.update();
Of course, now that we have done that, we will need to build a new copyLogoImage function. We already have a function that copies an attachment (Phase 4), and we can steal most of the code from that guy.
processPhase4: function(answer) {
var gsa = new GlideSysAttachment();
var values = gsa.copy('sys_app', answer.appSysId, 'x_11556_col_store_member_application_version', answer.versionId);
gsa.deleteAttachment(answer.attachmentId);
if (values.length > 0) {
var ids = values[values.length - 1].split(',');
if (ids[1]) {
answer.attachmentId = ids[1];
} else {
answer = this.processError(answer, 'Unrecognizable response from attachment copy: ' + values);
}
} else {
answer = this.processError(answer, 'Unrecognizable response from attachment copy: ' + values);
}
return answer;
}
We want to return the attachment sys_id and not the answer object, and we need to swap out the table names, but other than that, it looks pretty similar:
copyLogoImage: function(answer) {
var logoId = '';
var gsa = new GlideSysAttachment();
var values = gsa.copy('ZZ_YYsys_app', answer.appSysId, 'ZZ_YYx_11556_col_store_member_application', answer.mbrAppId);
if (values.length > 0) {
var ids = values[values.length - 1].split(',');
if (ids[1]) {
logoId = ids[1];
} else {
answer = this.processError(answer, 'Unrecognizable response from logo attachment copy: ' + values);
}
} else {
answer = this.processError(answer, 'Unrecognizable response from logo attachment copy: ' + values);
}
return logoId;
}
That will get the logo image from the Scoped Application attached to our application record during the application publishing process. Now we need to take a look at those functions that send the local artifacts over to the Host instance and see if we can alter them to use the newly modified shared function. The first of such functions is processPhase5, and it moves over the application record.
processPhase5: function(answer) {
var mbrAppGR = new GlideRecord('x_11556_col_store_member_application');
if (mbrAppGR.get(answer.mbrAppId)) {
var host = gs.getProperty('x_11556_col_store.host_instance');
var token = gs.getProperty('x_11556_col_store.active_token');
var thisInstance = gs.getProperty('instance_name');
var request = new sn_ws.RESTMessageV2();
request.setHttpMethod('get');
request.setBasicAuth(this.WORKER_ROOT + host, token);
request.setRequestHeader("Accept", "application/json");
request.setEndpoint('https://' + host + '.service-now.com/api/now/table/x_11556_col_store_member_application?sysparm_fields=sys_id&sysparm_query=provider.instance%3D' + thisInstance + '%5Ename%3D' + encodeURIComponent(mbrAppGR.getDisplayValue('name')));
var response = request.execute();
if (response.haveError()) {
answer = this.processError(answer, 'Error returned from Host instance: ' + response.getErrorCode() + ' - ' + response.getErrorMessage());
} else if (response.getStatusCode() == '200') {
var jsonString = response.getBody();
var jsonObject = {};
try {
jsonObject = JSON.parse(jsonString);
} catch (e) {
answer = this.processError(answer, 'Unparsable JSON string returned from Host instance: ' + jsonString);
}
if (!answer.error) {
var payload = {};
payload.name = mbrAppGR.getDisplayValue('name');
payload.scope = mbrAppGR.getDisplayValue('scope');
payload.description = mbrAppGR.getDisplayValue('description');
payload.current_version = mbrAppGR.getDisplayValue('current_version');
payload.active = 'true';
request = new sn_ws.RESTMessageV2();
request.setBasicAuth(this.WORKER_ROOT + host, token);
request.setRequestHeader("Accept", "application/json");
if (jsonObject.result && jsonObject.result.length > 0) {
answer.hostAppId = jsonObject.result[0].sys_id;
request.setHttpMethod('put');
request.setEndpoint('https://' + host + '.service-now.com/api/now/table/x_11556_col_store_member_application/' + answer.hostAppId);
} else {
request.setHttpMethod('post');
request.setEndpoint('https://' + host + '.service-now.com/api/now/table/x_11556_col_store_member_application');
payload.provider = thisInstance;
}
request.setRequestBody(JSON.stringify(payload, null, '\t'));
response = request.execute();
if (response.haveError()) {
answer = this.processError(answer, 'Error returned from Host instance: ' + response.getErrorCode() + ' - ' + response.getErrorMessage());
} else if (response.getStatusCode() != 200 && response.getStatusCode() != 201) {
answer = this.processError(answer, 'Invalid HTTP Response Code returned from Host instance: ' + response.getStatusCode());
} else {
jsonString = response.getBody();
jsonObject = {};
try {
jsonObject = JSON.parse(jsonString);
} catch (e) {
answer = this.processError(answer, 'Unparsable JSON string returned from Host instance: ' + jsonString);
}
if (!answer.error) {
answer.hostAppId = jsonObject.result.sys_id;
}
}
}
} else {
answer = this.processError(answer, 'Invalid HTTP Response Code returned from Host instance: ' + response.getStatusCode());
}
} else {
answer = this.processError(answer, 'Invalid Member Application sys_id: ' + answer.appSysId);
}
return answer;
}
The corresponding shared function is pushApplication in the CollaborationStoreUtils Script Include, which takes the application GlideRecord, the target instance GlideRecord, and the sys_id of the local instance on the target instance as arguments. We already have the application GlideRecord, but will need to fetch the GlideRecord for the Host instance and grab the sys_id of local instance on the Host instance before we can make the call. Assuming that we can create a couple of functions to gather up the information that we need, we can reduce the new processPhase5 function to this:
processPhase5: function(answer) {
var applicationGR = new GlideRecord('x_11556_col_store_member_application');
if (applicationGR.get(answer.mbrAppId)) {
var targetGR = this.getHostInstanceGR();
var csu = new CollaborationStoreUtils();
answer.hostInstanceId = csu.getRemoteInstanceSysId(targetGR);
var result = csu.pushApplication(applicationGR, targetGR, answer.hostInstanceId);
if (result.error) {
answer = this.processError(answer, 'Error returned from Host instance: ' + result.error_code() + ' - ' + result.error_message);
} else if (result.parse_error) {
answer = this.processError(answer, 'Unparsable JSON string returned from Host instance: ' + result.body);
} else if (result.status != 200 && result.status != 201) {
answer = this.processError(answer, 'Invalid HTTP Response Code returned from Host instance: ' + result.status);
} else {
answer.hostAppId = result.obj.result.sys_id;
}
} else {
answer = this.processError(answer, 'Invalid Member Application sys_id: ' + answer.mbrAppId);
}
return answer;
}
That simplifies the code quite a bit, and yet we will be doing more work, as we will be moving over the logo image and also logging all the REST API calls. Much better. Of course we still need to build out those function to gather up the required arguments, but those should both be fairly straightforward. To fetch the Host instance GlideRecord, I kept the function in the ApplicationPublisher Script Include, but I put the other one in the main CollaborationStoreUtils Script Include, as that involves another REST API call to the Host instance, and I want to keep all of the functions that do that together in the same place. Here is the getHostInstanceGR function in the ApplicationPublisher Script Include:
getHostInstanceGR: function() {
var instanceGR = new GlideRecord('x_11556_col_store_member_organization');
instanceGR.get('instance', gs.getProperty('x_11556_col_store.host_instance'));
return instanceGR;
}
And here is the getRemoteInstanceSysId function in the CollaborationStoreUtils Script Include:
getRemoteInstanceSysId: function(targetGR) {
var sysId = '';
var result = {};
result.url = 'https://' + targetGR.getDisplayValue('instance') + '.service-now.com/api/now/table/x_11556_col_store_member_organization?sysparm_fields=sys_id&sysparm_query=instance%3D' + gs.getProperty('instance_name');
result.method = 'GET';
var request = new sn_ws.RESTMessageV2();
request.setEndpoint(result.url);
request.setHttpMethod(result.method);
request.setBasicAuth(this.WORKER_ROOT + targetGR.getDisplayValue('instance'), targetGR.getDisplayValue('token'));
request.setRequestHeader('Content-Type', 'application/json');
request.setRequestHeader('Accept', 'application/json');
var response = request.execute();
result.status = response.getStatusCode();
result.body = response.getBody();
if (result.body) {
try {
result.obj = JSON.parse(result.body);
} catch (e) {
result.parse_error = e.toString();
}
}
result.error = response.haveError();
if (result.error) {
result.error_code = response.getErrorCode();
result.error_message = response.getErrorMessage();
} else if (result.obj && result.obj.result && result.obj.result.length > 0) {
sysId = result.obj.result[0].sys_id;
}
this.logRESTCall(targetGR, result);
return sysId;
}
So that takes care of the first of the three functions that need to modified to use the shared REST API functions. Now we just need to do the same thing for the other two, processPhase6 and processPhase7. That should be a little simpler now that we have done the first one, but it’s still a bit of work, so let’s save all of that for our next installment.
