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
vendors:redbox:callsuppression [2021/03/18 14:26] – ↷ Links adapted because of a move operation gerardorourkevendors:redbox:callsuppression [2024/02/28 09:58] (current) – [Installing / Uninstalling the Web Service API] gerardorourke
Line 15: Line 15:
 <alert type="info">The Gadget currently only supports a single Redbox Server. If you have multiple Redbox Servers for resilience - configure the recorders in a primary / standby approach. Then configure a gadget for each recorder, e.g. 'Redbox A (Primary)', 'Redbox B (Standby)' - and hide the gadgets which are not active, i.e. manually change the gadgets which the agent can see if the A side Redbox server is unavailable.</alert> <alert type="info">The Gadget currently only supports a single Redbox Server. If you have multiple Redbox Servers for resilience - configure the recorders in a primary / standby approach. Then configure a gadget for each recorder, e.g. 'Redbox A (Primary)', 'Redbox B (Standby)' - and hide the gadgets which are not active, i.e. manually change the gadgets which the agent can see if the A side Redbox server is unavailable.</alert>
  
 +
 +===== Key Support Info =====
 +  *The Gadget uses a redbox username (setup detailed below). This account is set in the gadget JavaScript File (sample extract below).
 +  *The Gadget connects to the recorder set in the JavaScript File.
 +  *If unable to connect - confirm that Recorder is up and running, Redbox Web Service API is running and the Finesse Server is able to connected to the Web Service API port (TCP 1480) (no Firewalls / connectivity issues stopping this).
 +
 +==== Extract of Gadget RedboxCallSuppression.js ====
 +Set the username, password and hostname in the RedboxCallSuppression.js file - as per example below.
 +
 +<code JavaScript>
 +    var _user;
 +    var _apiusername = 'redboxapi';
 +    var _apipassword = 'DVgTLKRc9VAt4h2T';
 +    var _host1 = 'redbox1.mydomain.com';
 +    var _baseURL = 'http://' + _host1 + ':1480';
 +    var _loginPath = '/api/v1/sessions/login';
 +    var _logoutPath = '/api/v1/sessions/logout';
 +    var _deviceListPath = '/api/v1/config/devices';
 +    var _suppressStartPath = '/api/v1/suppression/start/device';
 +    var _suppressStopPath = '/api/v1/suppression/stop/device';
 +    var _keepalivePath = '/api/v1/sessions/keepAlive';
 +    var _authToken;
 +    var _myExtension;
 +    var _myDeviceId = []; //Array for the Device IDs - as the recorder could have more than one.
 +    var _myDeviceIdCounter;
 +    var _connected = false;
 +    var _connectionStatus = 'not connected';
 +    var _keepaliveMsg = "";
 +    var _keepaliveCounter = 0;
 +    var _keepaliveMaxCounter = 3;
 +    var _keepaliveInterval = 150000; // defaults to 150000, i.e. 2.5 mins. The Redbox Session timer is 5 mins - so keepalives need to be set before this 5 min timer expires.
 +    var _userState = "";
 +    var _version = '1.1';
 +</code>
  
 ===== Detailed Work Flow details ===== ===== Detailed Work Flow details =====
Line 153: Line 187:
 **C:\LTR\utils\RedBoxInterfaceWebAPI** and run the command  **C:\LTR\utils\RedBoxInterfaceWebAPI** and run the command 
 <code>RedBoxInterfaceWebAPI.exe –i</code> <code>RedBoxInterfaceWebAPI.exe –i</code>
 +
 +After installing a new service should be added called "Red box Recorders Web API Service"\\
 +Make sure to start the service!
 +
 +{{:vendors:redbox:redbox-webservice.png?600|}}
 +
  
 To Uninstall run the command: To Uninstall run the command:
Line 159: Line 199:
 ===== Example Finesse Gadget XML Config ===== ===== Example Finesse Gadget XML Config =====
 Below is the config you add to the Finesse Admin to add the Gadget for the Agent. Below is the config you add to the Finesse Admin to add the Gadget for the Agent.
-You need to upload to the Finesse Servers into the relevant folder - see Cisco 3rd party gadget configuration documentation for more information.+You need to upload to the Finesse Servers into the relevant folder - see [[https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/cust_contact/contact_center/finesse/finesse_1251/admin/guide/cfin_b_1251-administration-guide/cfin_b_1251-administration-guide_chapter_01011.html|Cisco 3rd Party Gadget configuration documentation]] for more information.
  
 This example has the B side commented out - so only the A side appears for the Agent. This example has the B side commented out - so only the A side appears for the Agent.
Line 168: Line 208:
             <label>PCI-A-Side</label>             <label>PCI-A-Side</label>
     <gadgets>     <gadgets>
-     <gadget>/3rdpartygadget/files/RedboxCallSuppressionA_V1/RedboxCallSuppression.xml</gadget>+     <gadget>/3rdpartygadget/files/RedboxCallSuppressionA_V1.1/RedboxCallSuppression.xml</gadget>
                  </gadgets>                  </gadgets>
         </tab>         </tab>
Line 177: Line 217:
             <label>PCI-B-Side</label>             <label>PCI-B-Side</label>
  <gadgets>  <gadgets>
- <gadget>/3rdpartygadget/files/RedboxCallSuppressionB_V1/RedboxCallSuppression.xml</gadget>+ <gadget>/3rdpartygadget/files/RedboxCallSuppressionB_V1.1/RedboxCallSuppression.xml</gadget>
  </gadgets>  </gadgets>
          </tab>          </tab>
  • vendors/redbox/callsuppression.1616077570.txt.gz
  • Last modified: 2021/03/18 14:26
  • by gerardorourke