OnCallContactPrefTemplate : global

Fournit des méthodes permettant d’appliquer des modèles de préférence de contact à des ensembles d’escalade.

Pour en savoir plus sur le processus d’escalade, reportez-vous à Defining On-Call Scheduling escalation process.

Cette API nécessite le module d’extension On-Call Scheduling (com.snc.on_call_rotation).

OnCallContactPrefTemplate : OnCallContactPrefTemplate()

Instancie un objet OnCallContactPrefTemplate .

Tableau 1. Paramètres

Nom	Type	Description
Néant

Cet exemple instancie un objet OnCallContactPrefTemplate .

var contactPrefTemp = new global.OnCallContactPrefTemplate();

OnCallContactPrefTemplate : copyContactPreferences(String templateSysId, String escalationSetSysId)

Applique un modèle de préférence de contact à un ensemble d’escalades.

Lorsque le modèle est appliqué à l’ensemble d’escalades, les enregistrements de tentatives de contact sont créés dans la table Préférences de contact d’équipe [cmn_rota_contact_preference].

Avant d’appeler cette méthode, appelez la méthode deleteContactPreferenceAttempts() pour supprimer les enregistrements de tentatives de contact existants. Si les enregistrements existants ne sont pas supprimés en premier, cette méthode renvoie une erreur.

Tableau 2. Paramètres

Nom	Type	Description
templateSysId	Chaîne	Sys_id du modèle de préférence de contact dans la table Modèle de préférence de contact d’astreinte [on_call_template_contact_preference].
escalationSetSysId	Chaîne	Sys_id de l’ensemble d’escalade dans la table Ensemble d’escalades de l’équipe [cmn_rota_escalation_set].

Tableau 3. Renvoie

Type	Description
Objet	Objet contenant les messages d’erreur et d’avertissement. Si l’opération a réussi, cet objet est vide. Remarque : En cas d’erreur, l’opération s’arrête et le modèle n’est pas appliqué. Si un avertissement se produit, l’opération se poursuit et certains enregistrements sont toujours créés. { "error": "String", "warning": "String" }
<Object>.Erreur	Message d'erreur. Valeurs possibles : Le sys_id du modèle de préférence de contact n’est pas correct La sys_id de l’escalade n’est pas correcte Des tentatives de contact existent déjà Type de données : chaîne
<Object>.Avertissement	Message d’avertissement. Type de données : chaîne

Cet exemple applique un modèle de préférence de contact au Service Desk – Ensemble d’escalades par défaut. L’objet de retour est vide, car il n’y a pas d’erreurs ou d’avertissements.

var escSetSysId = "a47ac1abeb5a6110249e8d835d5228aa";
var templateSysId = "f8dac9ebeb5a6110249e8d835d522873";

var contactPrefTemp = new global.OnCallContactPrefTemplate();

// delete existing contact attempt records before applying the template
contactPrefTemp.deleteContactPreferenceAttempts(escSetSysId); 

var result = contactPrefTemp.copyContactPreferences(templateSysId, escSetSysId);
gs.info(JSON.stringify(result));

Sortie :

{}

OnCallContactPrefTemplate : deleteContactPreferenceAttempts(String escalationSetSysId)

Supprime toutes les préférences de contact associées à un ensemble d’escalades.

Tous les enregistrements de tentatives de contact pour l’ensemble d’escalades sont supprimés de la table Préférences de contact d’équipe [cmn_rota_contact_preference].

Tableau 4. Paramètres

Nom	Type	Description
escalationSetSysId	Chaîne	Sys_id de l’ensemble d’escalade dans la table Ensemble d’escalades de l’équipe [cmn_rota_escalation_set].

Tableau 5. Renvoie

Type	Description
Néant

Cet exemple supprime toutes les préférences de contact associées au Service Desk – Ensemble d’escalades par défaut.

var escSetSysId = "a47ac1abeb5a6110249e8d835d5228aa";
var contactPrefTemp = new global.OnCallContactPrefTemplate();

contactPrefTemp.deleteContactPreferenceAttempts(escSetSysId);