How to convert your existing 10.5.1 custom gadget to work with 10.6.1 and above?
Overview
Starting Finesse 10.6.1 (which is a UCCX release only):
- The Finesse JavaScript Library (finesse.js) and the jQuery Library (jQuery*.min.js) are hosted on the Finesse server itself. The files can be found under: http(s)://<FQDN>:<port>/desktop/assets/js/finesse.js & http(s)://<FQDN>:<port>/desktop/assets/js/jquery.min.js. As a result of this change, the sample gadget zips will no longer contain these files and do not need to be uploaded to the web server with the gadget files.
- The Finesse JavaScript Library documentation is hosted on the Finesse server itself. It can be accessed with the following URL: http(s)://<FQDN>:<port>/desktop/assets/js/doc/index.html
Starting Finesse 11.0.1:
- In addition to the Finesse JavaScript Library and documentation being hosted on the Finesse server as explained above, the finesse.gadget.Config is now built into the finesse.js and the user's id can be obtained from the config.
- Since the Finesse JavaScript Library files are now hosted on the Finesse server itself. Moving forward, these gadgets should not need any changes after a product upgrade unless there are significant changes in the new finesse.js file where it is not backwards compatible. When this happens, a new gadget version will be posted with the starting version number.
Convert your 10.5.1 gadget for 10.6.1
1. In the gadget's xml, change the following imports from:
<script type="text/javascript" src="jquery-@jquery.version@.min.js"></script>
<script type="text/javascript" src="finesse-@finesse.js.version@.js"></script>
to
<script type="text/javascript" src="/desktop/assets/js/jquery.min.js"></script>
<script type="text/javascript" src="/desktop/assets/js/finesse.js"></script>
If your gadget is hosted on the third party server, use the absolute URL.
2. Optional. Remove the old jquery-@jquery.version@.min.js & finesse-@finesse.js.version@.jsfiles as they are no longer needed
Convert your 10.5.1 gadget for 11.0.1/11.5.1/11.6.1/12.0.1/12.5.1
1. In the gadget's xml file, change the following imports from:
<script type="text/javascript" src="jquery-@jquery.version@.min.js"></script>
<script type="text/javascript" src="finesse-@finesse.js.version@.js"></script>
to
<script type="text/javascript" src="/desktop/assets/js/jquery.min.js"></script>
<script type="text/javascript" src="/desktop/assets/js/finesse.js"></script>
If your gadget is hosted on the third party server, use the absolute URL.
2. In the gadget's js file, remove the following code:
finesse.gadget.Config = (function () {
/** @scope finesse.gadget.Config */
return {
authorization: finesse.utilities.Utilities.getUserAuthString(),
country: prefs.getString("country"),
language: prefs.getString("language"),
locale: prefs.getString("locale"),
host: prefs.getString("host"),
hostPort: prefs.getString("hostPort"),
extension: prefs.getString("extension"),
mobileAgentMode: prefs.getString("mobileAgentMode"),
mobileAgentDialNumber: prefs.getString("mobileAgentDialNumber"),
xmppDomain: prefs.getString("xmppDomain"),
pubsubDomain: prefs.getString("pubsubDomain"),
restHost: prefs.getString("restHost"),
scheme: prefs.getString("scheme"),
localhostFQDN: prefs.getString("localhostFQDN"),
localhostPort: prefs.getString("localhostPort"),
clientDriftInMillis: prefs.getInt("clientDriftInMillis")
};
}());
3. In the gadget's js file, if you have code to get the user's id like this:
var prefs = new gadgets.Prefs(),
id = prefs.getString("id");
...change it to...
var cfg = finesse.gadget.Config;
4. To get the user's id, you must first call the ClientServices.init,
finesse.clientservices.ClientServices.init(finesse.gadget.Config);
then, you can access the id with:
cfg.id;
5. Optional. Remove the old jquery-@jquery.version@.min.js & finesse-@finesse.js.version@.js files as they are no longer needed
Convert your 10.6.1 gadget for 11.0.1/11.5.1/11.6.1/12.0.1/12.5.1
1. In the gadget's js file, remove the following code:
finesse.gadget.Config = (function () {
/** @scope finesse.gadget.Config */
return {
authorization: finesse.utilities.Utilities.getUserAuthString(),
country: prefs.getString("country"),
language: prefs.getString("language"),
locale: prefs.getString("locale"),
host: prefs.getString("host"),
hostPort: prefs.getString("hostPort"),
extension: prefs.getString("extension"),
mobileAgentMode: prefs.getString("mobileAgentMode"),
mobileAgentDialNumber: prefs.getString("mobileAgentDialNumber"),
xmppDomain: prefs.getString("xmppDomain"),
pubsubDomain: prefs.getString("pubsubDomain"),
restHost: prefs.getString("restHost"),
scheme: prefs.getString("scheme"),
localhostFQDN: prefs.getString("localhostFQDN"),
localhostPort: prefs.getString("localhostPort"),
clientDriftInMillis: prefs.getInt("clientDriftInMillis")
};
}());
2. In the gadget's js file, if you have code to get the user's id like this:
var prefs = new gadgets.Prefs(),
id = prefs.getString("id");
...change it to...
var cfg = finesse.gadget.Config;
3. To get the user's id, you must first call the ClientServices.init,
finesse.clientservices.ClientServices.init(finesse.gadget.Config);
then, you can access the id with:
cfg.id;
Comments
0 comments
Please sign in to leave a comment.