OnCallEscalationTemplateSNC : global

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 3 minutes de lecture
  • Fournit des méthodes pour appliquer des modèles de politique d’escalade à 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).

    OnCallEscalationTemplateSNC : OnCallEscalationTemplateSNC()

    Instancie un objet OnCallEscalationTemplateSNC .

    Tableau 1. Paramètres
    Nom Type Description
    Néant

    Cet exemple instancie un objet OnCallEscalationTemplateSNC .

    var escTemp = new global.OnCallEscalationTemplateSNC();

    OnCallEscalationTemplateSNC : copyEscalationTemplatetoEscalationSet(String templateSysId, String escalationSetSysId)

    Applique un modèle de politique d’escalade à un ensemble d’escalades.

    Lorsque le modèle est appliqué à l’ensemble d’escalade, les enregistrements de définition d’étape d’escalade sont créés dans la table Définition de l’étape d’escalade de l’équipe [cmn_rota_esc_step_def].

    Avant d’appeler cette méthode, appelez la méthode deleteEscalationSetSteps() pour supprimer les définitions d’étapes d’escalade existantes. 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 politique d’escalade dans la table Modèle de politique d’escalade d’astreinte [on_call_template_escalation_policy].
    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": {Object} 
    }
    <Object>.Erreur Message d'erreur.
    Erreurs possibles :
    • La sys_id du modèle de politique d’escalade n’est pas correcte.
    • Le paramètre d’escalade sys_id n’est pas correct.
    • Des définitions d’étapes d’escalade existent déjà dans l’ensemble d’escalade.

    Type de données : chaîne

    <Object>.Avertissement Informations sur les avertissements.

    Type de données : objet

    {
      "message": "String", 
      "skipped_steps": [Array],
      "not_matching_steps": {Object},
    }
    <Object>.avertissement.message Message d’avertissement.
    Avertissements possibles :
    • La position de liste ne correspond pas aux listes de l’équipe
    • Aucune audience n’est définie sur le modèle d’étape d’escalade

    Type de données : chaîne

    <Object>.warning.skipped_steps Index de toutes les étapes d’escalade qui ont été ignorées (de base 1).

    Type de données : tableau

    <Object>.warning.not_matching_steps Objet contenant des informations sur les étapes d’escalade pour lesquelles aucune liste n’est disponible au format {&quot;step number » :[roster number]}.

    Par exemple, si la valeur de retour est {&quot;3 » :[3]}, la liste tertiaire n’est pas disponible à la troisième étape d’escalade.

    Type de données : objet

    Cet exemple applique le modèle de politique d’escalade Alterner les listes 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 = "32820dc3eb422110249e8d835d5228c3";
    var templateSysId = "a89e2982eb592110249e8d835d522825";
    var escTemp = new global.OnCallEscalationTemplateSNC();
    
    // delete existing escalation step definitions before applying the template
    escTemp.deleteEscalationSetSteps(escSetSysId);
    
    var result = escTemp.copyEscalationTemplatetoEscalationSet(templateSysId, escSetSysId);
    gs.info(JSON.stringify(result));

    Sortie :

    {}

    Cet exemple applique le modèle de politique d’escalade Alterner par liste à l’ensemble Heures de travail – Escalade par défaut. Dans ce cas, l’équipe de développement d’application n’a que deux listes, mais le modèle tente d’affecter une troisième liste. Comme le nombre de listes ne correspond pas, un avertissement est lancé. Deux enregistrements sont encore en cours de création dans la table Définition de l’étape d’escalade des équipes [cmn_rota_esc_step_def].

    var escSetSysId = "e4f8f73deb562110249e8d835d522852";
    var templateSysId = "a89e2982eb592110249e8d835d522825";
    var escTemp = new global.OnCallEscalationTemplateSNC();
    
    // delete existing escalation step definitions before applying the template
    escTemp.deleteEscalationSetSteps(escSetSysId);
    
    var result = escTemp.copyEscalationTemplatetoEscalationSet(templateSysId, escSetSysId);
    gs.info(JSON.stringify(result));

    Sortie :

    {
       "warning": {
          "message": "Skipped copying templates for some of the steps since no audiences are defined",
          "not_matching_steps": {
             "3": [
                3
             ]
          },
          "skipped_steps": [
             "3"
          ]
       }
    }

    OnCallEscalationTemplateSNC : deleteEscalationSetSteps(String escalationSetSysId)

    Supprime tous les enregistrements de définition d’étape d’escalade associés à un ensemble d’escalades.

    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 définitions d’étapes d’escalade associées à l’ensemble d’escalade Service Desk – Par défaut.

    var escSetSysId = "32820dc3eb422110249e8d835d5228c3";
    
    var escTemp = new global.OnCallEscalationTemplateSNC();
    
    escTemp.deleteEscalationSetSteps(escSetSysId);