Custom Gadgets for Cisco Finesse

[Rohit Khajuria]

Hi All

Thanks all in advance !!!

Can anyone please tell me where to upload Custom Gadgets for Cisco Finesse ?

Where can we store them ?

[Jinto Alakkal · Accepted solution]

Hi Please follow the below steps to upload it to the Finesse you can either upload it to a directory in finesse using SFTP or you can use a Webserver, it is documented here

https://learninglabs.cisco.com/lab/finesse-add-a-gadget/

Finesse provides a mechanism for you to upload third-party gadgets to the Finesse server. This mechanism allows one user, the 3rdpartygadget user, to upload gadgets to the /files directory on the Finesse server using secure FTP (SFTP). The 3rdpartygadget account only has permission to this directory and any directories created under it. In order to use the 3rdpartygadget account to upload gadgets using SFTP, you must set the password for this account via CLI (command line interface). For more details about the 3rdpartygadget account, see Password for 3rdpartygadget account.

Note: This step only needs to be completed once per installation. You may skip this step if you have already completed it from a different Finesse lab for this particular sandbox instance. If you are unsure, continue with this step as it does not hurt to repeat it.

1. Establish a SSH session with the Finesse server,

   • Open PuTTY, a SSH client.
   • Enter the Finesse FQDN {{web-url}}in the Host Name (or IP address) field.

   • Click Open.

     

   • If the PuTTY Security Alert window appears, click Yes.

     

   • The terminal window opens.
   • In the terminal window, enter {{admin_username}} in the login as field.

   • Enter {{admin_password}} in the {{admin_username}}@{{web-url}}'s password field.

     

   • The Finesse server Platform Command Line Interface appears.

     

2. Set the 3rdpartygadget account password.

   • In the Platform Command Line Interface, enter the following to change the password: utils reset_3rdpartygadget_password.
   • Enter ciscocisco for the New Password and again for Confirm New Password.

   • If the password is successfully set, you will see "Password updated successfully."

     

   • If you get an error that there is a password mismatch, redo this step and type the passwords slowly.

Upload the sample gadget

Finesse gadgets are OpenSocial gadgets. An OpenSocial Gadget is an XML document that defines metadata for an OpenSocial Gadget container, the Finesse agent desktop. Gadgets are highly cacheable so it does not need a high-performance server.

A gadget consists of the following:

• XML to define metadata
• HTML for markup
• JavaScript for interactivity
• CSS for presentation & style

In order to add custom (third-party) gadgets to the Finesse out-of-the-box agent desktop, you must host them on a web server. As mentioned in the previous step, you can upload your gadgets to the Finesse server, but it is not mandatory. You can use your own web server as long as it is accessible by both the Finesse server and the agent workstation. For more information about uploading third-party gadgets, go to the Upload Third-Party Gadgets section in the Finesse Developer Guide.

1. Unzip the sample gadget that you downloaded from the DevNet Finesse page.

   • Locate and unzip the EmbeddedWebAppSampleGadget-Finesse-x.x.x-vx.x.zip file that you had downloaded in Step 1. You should see the following files in the folder:

     _readme.txt
     FinesseJavaScriptLibrary/
        readme.txt
     EmbeddedWebApp/
        EmbeddedWebApp.css
        EmbeddedWebApp.js
        EmbeddedWebApp.xml
     EmbeddedWebApp.pdf
     

2. Upload the sample gadget to the Finesse server.

   • Open FileZilla, a SFTP client.
   • In the quickconnect bar,
     • Enter the Finesse FQDN: {{web-url}} in the Host field.
     • Enter 3rdpartygadget in the Username field.
     • Enter ciscocisco in the Password field. This is the 3rdpartygadget password defined in the previous step.
     • Enter 22 in the Port field.

   • Click Quickconnect.

     

   • If a Remember Passwords? window appears, select Do not save passwords and click OK.

   • An Unknown host key window will appear.
     • Select Always trust this host, add this key to the cache and click OK.

   • Verify that the connection was successful.

     • In the message log section, confirm that you see a line that says:

       Status:     Connected to {{web-url}}.

     • In the remote site section, confirm that you see a folder named / and you can see the files folder below.

     

   • Transfer the EmbeddedWebApp gadget.

     • Drag the EmbeddedWebApp folder (that contains the xml, js, and css) into the files folder. Note that this is the folder inside of the EmbeddedWebAppSampleGadget-Finesse-x.x.x-vx.x folder.
     • Confirm that the transfer was successful by checking that the transfers shows up in the Successful transfers tab at the bottom.

     

   • Change the file permissions of the gadget files. The gadget files have to have public read permissions for it to be loaded on the Finesse agent desktop.

     • Select the EmbeddedWebApp folder.
     • Right-click on the EmbeddedWebApp folder.
     • From the dropdown menu, select File permissions....
     • A Change file attributes window appears.
     • Under Public permissions verify that Read permissions is selected.
     • Select Recurse into subdirectories.
     • Click OK.

     

3. Confirm that you can access the gadget.

   • Open Chrome and go to the following URL: https://{{web-url}}:8445/3rdpartygadget/files/EmbeddedWebApp/EmbeddedWebApp.xml
   • If the sample gadget was uploaded successfully, you will see content of the EmbeddedWebApp.xml file in the browser window.

   

[Rohit Khajuria]

Thanks a lot for the doc !!!

[Roy_11]

Hi

I saw yours reply's are very nice , it will very helpful ,
Can you help me on my cases Please please ,?????


Anyone expert in finesse logging setup please share your comments ,actually i am trying for logging setup for 3rd party Gadget to finesse Client Logs , i have one XML file , finesse.module.file1.init() function is one , this init() i called in 1st javascript its working , i am able to see Logs in finesse client log , but i am not able to call the 2nd javascript its not executing , if i create another finesse.module.file2 init() in xml also , please let me know how way i have call for 2nd javascript ?????? so can you help me experts , i am facing since long back , i want to fix this with your comments .

Please !!
Thanks!