Documentazione Javascript SDK
- Felice Griffi
Per consentire la comunicazione bidirezionale della propria web-application con CTView e ricevere quindi le notifiche dei dati che si è scelto di monitorare, è necessario caricare la libreria di sviluppo CTView SDK:
<script type="text/javascript" src="https://<CTVIEW_DOMAIN>/CTView/sdk/ctview_sdk.js"></script>Una volta istanziata si avrà a disposizione un oggetto (namespace) CTVIEW.
Con il namespace CTVIEW si potrà accedere ad una serie di oggetti e metodi che consentono di specificare quali risorse e quali metriche si vuole monitorare nella propria applicazione.
jQuery versione 2.2.4 - CTView SDK offre al suo interno una istanza isolata della famosa libreria jQuery. E' sufficiente utilizzare l’oggetto CTVIEW.JQ
Inizializzazione della libreria
Prima di poter specificare le risorse da monitorare occorre attendere che la libreria SDK venga correttamente inizializzata e quindi il canale bidirezionale da e verso CTView sia correttamente funzionante.
Per fare questo è disponibile una API specifica che notifica la corretta inizializzazione della libreria. E' possibile agganciare una propria callback per essere notificati.
Funzione | Descrizione |
|---|---|
CTVIEW.WIDGET.bindSDKReadyCallback javascript function | Effettua la bind di una propria funzione javascript al fine di ricevere la notifica della avvenuta inizializzazione della libreria. jQuery( document ).ready(
function() {
CTVIEW.WIDGET.bindSDKReadyCallback(
function (event, data) {
console.log("[CTVIEW WIDGET IFRAME] SDK Ready to use...");
}
);
}
);
|
Monitoraggio delle risorse
Una volta avvenuta la inizializzazione della libreria si deve indicare quale risorse e quali dati si vuole monitorare. Ogni volta che CTView riceverà un valore aggiornato provvederà a notificarlo immediatamente alla istanza della libreria SDK in esecuzione nel proprio Widget. Non viene eseguito nessun buffering dei dati.
E' possibile selezionare quali categorie di risorse si vuole monitorare (Operatori o Gruppi) e all’interno di questi quali dati si vuole ricevere (Scalar oppure Contatti).
La integrazione ha il compito di eseguire il binding di una propria funzione custom che verrà richiamata per notificare la disponibilità di dati aggiornati.
Funzione | Descrizione |
|---|---|
CTVIEW.WIDGET.startMonitorResourceScalar String ResourceType, String Resources, String Scalars | Richiede il monitoring delle risorse e delle metriche (Scalars) indicati dai seguenti parametri:
|
CTVIEW.WIDGET.stopMonitorResourceScalar String ResourceType, String Resources | Interrompe il monitoraggio di tutti gli Scalar sulla risorsa specificata. |
CTVIEW.WIDGET.startMonitorDistinctScalar String ResourceType, String Resources, String Scalars | Richiede il monitoring di un particolare sottoinsieme di Scalar fornendo il valore totale calcolandolo univocamente sulla base delle risorse selezionate. Gli Scalar disponibili per il monitoraggio distinto per risorsa sono i seguenti:
Una volta richiesto il monitoring di un particolare Scalar, CTView provvederà a notificare alla funzione di callback la somma totale dei valori distinti per risorsa. Se per esempio prendiamo lo Scalar 13002 (AgentsLoggedIn) se un operatore risulta loggato su più code nel totale verrà conteggiato in modo univoco. Questo metodo è differente dall’eseguire una pura e semplice somma del valore dello Scalar 13002 per ciascuna coda in quanto si può facilmente riscontrare il problema di conteggi multipli dello stesso operatore. Il metodo richiede i seguenti parametri:
CTVIEW.WIDGET.startMonitorDistinctScalar("QUEUE", "*", "13002"); |
CTVIEW.WIDGET.stopMonitorDistinctScalar | Interrompe il monitoraggio di tutti gli Scalar aggregati per risorsa |
CTVIEW.WIDGET.bindScalarChangeCallback Javascript function | Effettua la bind di una propria funzione javascript al fine di ricevere una notifica contenente nuovi dati aggiornati. Il dato aggiornato viene notificato alla funzione di callback mediante un oggetto con le seguenti proprietà:
|
CTVIEW.WIDGET.bindDistinctScalarChangeCallback Javascript function | Effettua la bind di una propria funzione javascript al fine di ricevere una notifica contenente nuovi dati aggregati aggiornati. Il dato aggiornato viene notificato alla funzione di callback mediante un oggetto con le seguenti proprietà.
|
CTVIEW.WIDGET.bindScalarDumpCallback Javascript function | Effettua la bind di una propria funzione javascript al fine di ricevere una notifica contenente il dump iniziale di tutti gli Scalar che si è scelto di monitorare. Il dump aggiornato viene notificato alla funzione di callback mediante un array dove ciascun elemento è un oggetto con le seguenti proprietà: |
Informazioni sulla utenza loggata
E' possibile richiedere alcune informazioni relativa alla utenza loggata e ai CallCenter/Partner/MacroAttività visibili da CTView.
Funzione | Descrizione |
|---|---|
CTVIEW.WIDGET.getCTViewUserData | Richiede alcune informazioni relative alla utenza loggata in CTView. Viene restituita una promise Javascript che verrà risolta restituendo un oggetto composto dalle seguenti proprietà:
|