Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revisionBoth sides next revision
vendors:cisco:uc:finesse [2020/01/06 08:28] gerardorourkevendors:cisco:uc:finesse [2021/01/13 16:17] – [RuntimeConfigInfo] gerardorourke
Line 5: Line 5:
  
 ===== Gadgets ===== ===== Gadgets =====
 +  *https://developers.google.com/gadgets
 +  *[[vendors:cisco:uc:finesse:gadgets|My Gadgets]]
   *https://developers.google.com/gadgets/docs/overview   *https://developers.google.com/gadgets/docs/overview
 +  *[[https://developers.google.com/gadgets/docs/reference#makerequest|Gadget MakeRequest]]
 +  *[[vendors:cisco:uc:finesse:GadgetCodeSnippets|Gadget Code Snippets]]
 +  *[[https://opensocial.atlassian.net/wiki/spaces/OSD/pages/527239/Gadgets.io+v0.9|More OpenSocial Gadget Docs]]
   *https://developer.cisco.com/site/finesse/   *https://developer.cisco.com/site/finesse/
 +  *https://community.cisco.com/t5/contact-center/third-party-gadget-height/td-p/3481350
 +  *https://api.jquery.com/html/
  
 ===== Links ===== ===== Links =====
Line 18: Line 25:
  
 =====Finesse API ===== =====Finesse API =====
 +==== Predefined Reason Codes ====
 +
 +https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/cust_contact/contact_center/finesse/finesse_1201/Admin/guide/cfin_b_1201-administration-guide-release-1201/cfin_b_1201-administration-guide-release-1201_chapter_0110.html#reference_E74540548AEB39553C82AE091C232CD4
 +
 +
 ==== Performance Stats ===== ==== Performance Stats =====
   * https://developer.cisco.com/docs/finesse/#!diagnostic-portalget-performance-information/diagnostic-portalget-performance-information   * https://developer.cisco.com/docs/finesse/#!diagnostic-portalget-performance-information/diagnostic-portalget-performance-information
Line 178: Line 190:
 <User> <User>
 <state>NOT_READY</state> <state>NOT_READY</state>
 +<reasonCodeId>1</reasonCodeId>
 </User> </User>
 </code> </code>
Line 201: Line 214:
   * {{ :vendors:cisco:uc:clicktocall_gerry_v1.zip |make Call allowed when in HOLD state}}   * {{ :vendors:cisco:uc:clicktocall_gerry_v1.zip |make Call allowed when in HOLD state}}
  
-====Gadget Caching====+=====Gadget Caching====
 + 
 +Clear Caching by  
 +  * restarting 'Cisco Finesse Tomcat'  
 +  * use the CLI command **utils webproxy cache clear shindig** to clear the Shindig cache. 
 +  * Pass a "nocache" parameter in the URL to clear the cache.\\
  
-Clear Caching by restarting 'Cisco Tomcat ' (Cisco Finesse Tomcat on UCCX)\\ 
-or pass a "nocache" paramter in the URL to clear the cache.\\ 
 Example:\\ Example:\\
-  * http://server?nocache +    * http://server?nocache 
-  * http://server/desktop?nocache +    * http://server/desktop?nocache 
-  * http://server/desktop/container?nocache+    * http://server/desktop/container?nocache
  
  
Line 408: Line 424:
 callKeyCallId callKeyCallId
 callKeyPrefix callKeyPrefix
 +</code>
 +
 +==== Call History Gadget ====
 +<code xml>
 +    <tab>
 +        <id>myHistory</id>
 +        <icon>history</icon>
 +        <label>finesse.container.tabs.agent.myHistoryLabel</label>
 +             <columns>
 +               <column>
 +                 <!-- The following gadgets are used for viewing the call history and state history of an agent. -->
 +                     <gadgets>
 +                       <gadget>https://my-cuic-server:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=280&amp;viewId=5FA44C6F930C4A64A6775B21A17EED6A&amp;filterId=agentTaskLog.id=CL%20teamName</gadget>
 +                       <gadget>https://my-cuic-server:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=280&amp;viewId=56BC5CCE8C37467EA4D4EFA8371258BC&amp;filterId=agentStateLog.id=CL%20teamName</gadget>
 +                       </gadgets>
 +                </column>
 +              </columns>
 +           </tab>
 +</code>
 +
 +
 +====alternateHosts Configuration ====
 +The <gadget> element in the Finesse Layout XML provides an attribute to specify alternate hosts from which the gadget can be loaded. This allows the Cisco Finesse desktop to load the gadget using a different host if the primary server is unavailable.
 +
 +The alternateHosts attribute contains a comma-separated list of FQDNs that will be used if the primary-host-FQDN is unavailable.
 +
 +<code>
 +<gadget alternateHosts="host1,host2,host3,...">
 +         https://<primary-host-FQDN>/<gadget-URL> 
 +    </gadget>
 +</code>    
 +
 +
 +===== Serviceability API Examples =====
 +
 +====RuntimeConfigInfo====
 +URL: https://finesse1.xyz.com/finesse/api/RuntimeConfigInfo
 +
 +<code xml>
 +<RuntimeConfigInfo>
 +<activeDialogCount>123</activeDialogCount>
 +<activeTaskCount>0</activeTaskCount>
 +<averageConfiguredMediaPerAgent>1</averageConfiguredMediaPerAgent>
 +<averageLoggedInMediaPerAgent>1</averageLoggedInMediaPerAgent>
 +<averageSkillGroupCountPerAgent>3</averageSkillGroupCountPerAgent>
 +<maxSkillGroupCountPerAgent>10</maxSkillGroupCountPerAgent>
 +<timeToInService>4</timeToInService>
 +<totalLoggedInAgentsInNode>203</totalLoggedInAgentsInNode>
 +<uniqueConfiguredSkillGroups>64</uniqueConfiguredSkillGroups>
 +<uri>/finesse/api/RuntimeConfigInfo</uri>
 +</RuntimeConfigInfo>
 +</code>
 +
 +
 +==== Get Product Version ====
 +
 +URL: https://finesse1.xyz.com/finesse-dp/rest/DiagnosticPortal/GetProductVersion
 +<code xml>
 +<dp:GetProductVersionReply xmlns:dp="http://www.cisco.com/vtg/diagnosticportal" ReturnCode="0">
 +<dp:Schema Version="1.0"/>
 +<dp:ProductVersion VersionString="12.0(1)" Maintenance="1" Minor="0" Major="12" Name="Cisco Finesse"/>
 +<dp:ComponentVersionList/>
 +</dp:GetProductVersionReply>
 </code> </code>
  • vendors/cisco/uc/finesse.txt
  • Last modified: 2024/03/19 11:29
  • by gerardorourke