Accepted Solutions
Thanks for that point in the right direction.
I wasted like 8 hours last night messing around with the LearningSampleGadget-2.0 on my UCCX 10.6(1)SU2 system. Turns out, v2.0 samples only work in UCCX 11.x. How do I know? I spun up a dCloud demo for UCCX 11.x and they work there. Also, why do I have to restart Cisco Finesse Tomcat 90% of the time to get new gadget code to render in the browser? It's like the caching on these things is so darn aggressive. Anything I can do to speed up my development cycle? Write code, save, upload, refresh, test, repeat.
Anyway, so now I'm in the UCCX 11.x on dCloud and I'm trying to get this WebService sample app tweaked to upload the ClientLogs, and I'm having some trouble with the following: The ClientLogs API requires the Agent ID ("aholloway" in my case). The WebService sample app doesn't have access (or doesn't appear to) to this information, whereas when I load the LearningSampleGadget it's actually a shown to me with user.getId(). Is there a simple way to get the Agent ID into the WebServices app without all the extra stuff that's in the LearningSampleGadget? E.g., finesse.gadget.Config.id
When I try to use the following modification, the console shows "ReferenceError: finesse is not defined"
createNewWebServicesRequest : function (handlers) {
clientLogs.log("createNewWebServicesRequest(): in method");
var contentBody = {
ClientLog: {
logData: navigator.userAgent
}
};
handlers = handlers || {};
// TODO: change Rest path to match your own web server
this.myrestRequest("/finesse/api/User/" + finesse.gadget.Config.id + "/ClientLog", {
method: 'POST',
success: handlers.success,
error: handlers.error,
content: contentBody,
});
return this;
}
Then, I just hard coded the user ID for one Agent like this, just to see if the basics of calling the REST API was working, however, it was not working and I was still getting a finesse reference error in the console. Do I need to worry about HTTP Basic Auth and how it would need to be addressed or is that implicit in some underlying code, and the Agent's creds will automatically be passed with the make request?
createNewWebServicesRequest : function (handlers) {
clientLogs.log("createNewWebServicesRequest(): in method");
var contentBody = {
ClientLog: {
logData: navigator.userAgent
}
};
handlers = handlers || {};
// TODO: change Rest path to match your own web server
this.myrestRequest("/finesse/api/User/aholloway/ClientLog", {
method: 'POST',
success: handlers.success,
error: handlers.error,
content: contentBody,
});
return this;
}
I should mention that I did also update the host the sample is pointing at:
mymakeRequest : function (url, handler, params) {
clientLogs.log("mymakeRequest(): in method");
params = params || {};
params[gadgets.io.RequestParameters.HEADERS] = params[gadgets.io.RequestParameters.HEADERS] || {};
// This is the url we want to get to:
// http://10.88.194.158:8080/userContent/HelloWorld.html
// TODO: Change the IP address to your server
gadgets.io.makeRequest(encodeURI("https://uccx1.dcloud.cisco.com:8445") + url, handler, params);
clientLogs.log("mymakeRequest(): io.makeRequest to https://uccx1.dcloud.cisco.com:8445" + url);
}
I should mention that I did get the WebService Sample app to run successfully, when pointing the URL at an off box Web Server like so:
createNewWebServicesRequest : function (handlers) {
clientLogs.log("createNewWebServicesRequest(): in method");
var contentBody = {};
handlers = handlers || {};
// TODO: change Rest path to match your own web server
this.myrestRequest("/finesse/HelloWorld.xml", {
method: 'GET',
success: handlers.success,
error: handlers.error,
content: contentBody,
});
return this;
}
mymakeRequest : function (url, handler, params) {
clientLogs.log("mymakeRequest(): in method");
params = params || {};
params[gadgets.io.RequestParameters.HEADERS] = params[gadgets.io.RequestParameters.HEADERS] || {};
// This is the url we want to get to:
// http://10.88.194.158:8080/userContent/HelloWorld.html
// TODO: Change the IP address to your server
gadgets.io.makeRequest(encodeURI("http://ad1.dcloud.cisco.com") + url, handler, params);
clientLogs.log("mymakeRequest(): io.makeRequest to http://ad1.dcloud.cisco.com" + url);
}
But if I switch it to even just this, it fails with "finesse is not defined" in the web console.
createNewWebServicesRequest : function (handlers) {
clientLogs.log("createNewWebServicesRequest(): in method");
var contentBody = {};
handlers = handlers || {};
// TODO: change Rest path to match your own web server
this.myrestRequest("/finesse/api/SystemInfo", {
method: 'GET',
success: handlers.success,
error: handlers.error,
content: contentBody,
});
return this;
}
mymakeRequest : function (url, handler, params) {
clientLogs.log("mymakeRequest(): in method");
params = params || {};
params[gadgets.io.RequestParameters.HEADERS] = params[gadgets.io.RequestParameters.HEADERS] || {};
// This is the url we want to get to:
// http://10.88.194.158:8080/userContent/HelloWorld.html
// TODO: Change the IP address to your server
gadgets.io.makeRequest(encodeURI("http://uccx1.dcloud.cisco.com:8082") + url, handler, params);
clientLogs.log("mymakeRequest(): io.makeRequest to http://uccx1.dcloud.cisco.com:8082" + url);
}
I get so happy when I see your reply hit my email inbox. Thank you for helping. 
Working backwards in the replies...
No, I did not delete the lines at the top. In fact, if I simply change the host from ad1.dcloud.cisco.com to uccx1.dcloud.cisco.com:8082, that is enough to break it. So, my question would then be: "Is there some restriction or limitation on a Finesse Gadget making a call to itself? I.e., Using FQDN vs IP vs localhost? HTTP vs HTTPS? Something else?
I would love to see what you're doing in Firebug, because: A) I didn't understand what you explained, and B) I think it would save my sanity, as opposed to waiting and restarting services that take 10 minutes to return (at least in dCloud they do). Could you post screenshots, or a screencast of your development process?
If the gadget is being hosted on the Finesse server, you just need to use localhost. You need to make sure the url is accessible from the Finesse server itself.
Let me try to explain my development hack in text and screenshots:
1) My gadget's JS file is called WebService.js
2) WebService.js file on a text editor is 244 lines.
3) With the gadget loaded on the Finesse UI, I open Firebug and go to the Script tab.
4) In the area that starts contact?container..., click that and type in WebService.js (it will filter the list of script files).
5) Select the file that ends in WebService.js.
6) Scroll down and notice that the green line numbers match the javascript's lines.
7) I make my changes to WebService.js
8) If the number of lines of WebService.js is still 244, then I add a log statement to make the number of lines 245 (or more).
9) I upload the WebService.js file to the Finesse server.
10) I click Refresh to reload the Finesse desktop.
11) I go back to Firebug's Script Tab and go to the WebService.js just like earlier.
12) Notice how the line number is not green where I added the log statement?
13) The lines after this added line are also incorrect in terms of being marked green.
14) This is how I know that the WebService.js file is cached.
15) Refresh the page again.
16) Go back to the WebService.js on the Script tab and the green line numbers should match the javascript lines.
17) This is how I know that the WebService.js is using the latest version.
Make sure you actually go to the script tab and the WebService.js file in step 12. If you don't and just refresh the page twice, it will continue to be cached. I think Firebug needs to load the file and the green lines to realize that it is cached.
I know this is tedious, but it is way faster than restarting tomcat. I hope this improves the speed of your development.
Thanx,
Denise
