OnCallContactPrefTemplate - Global

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 2 min. de leitura
  • . OnCallContactPrefTemplate a inclusão de script fornece métodos para aplicar modelos de preferência de contato a conjuntos de escalação.

    Para obter mais informações sobre o processo de escalação, consulte Defining On-Call Scheduling escalation process.

    Esta inclusão de script requer o plug-in Programação de plantão (com.snc.on_call_rotation).

    OnCallContactPrefTemplate - OnCallContactPrefTemplate()

    Instancia um OnCallContactPrefTemplate objeto.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum(a)

    Este exemplo instancia um OnCallContactPrefTemplate objeto.

    var contactPrefTemp = new global.OnCallContactPrefTemplate();

    OnCallContactPrefTemplate - copyContactPreferences(cadeia de caracteres templateSysId, cadeia de caracteres escalationSetSysId)

    Aplica um modelo de preferência de contato a um conjunto de escalação.

    Quando o modelo é aplicado ao conjunto de escalação, os registros de tentativa de contato são criados na tabela Preferência de contato de turno [cmn_rota_contact_preference].

    Antes de chamar este método, chame DeleteContactPreferenceAttempts() método para excluir registros de tentativa de contato existentes. Se os registros existentes não forem excluídos primeiro, este método retornará um erro.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    templateSysId Cadeia de caracteres Sys_id do modelo de preferência de contato na tabela Modelo de preferência de contato de plantão [on_call_template_contact_preference].
    EscalationSetSysId Cadeia de caracteres Sys_id do conjunto de escalação na tabela Conjunto de escalação de turno [cmn_rota_escalation_set].
    Tabela 3. Retornos
    Tipo Descrição
    Objeto
    Objeto que contém mensagens de erro e aviso. Se a operação foi bem-sucedida, este objeto estará vazio.
    Nota:
    Se ocorrer um erro, a operação será interrompida e o modelo não será aplicado. Se ocorrer um aviso, a operação continuará e alguns registros ainda serão criados.
    {
      "error": "String", 
      "warning": "String" 
    }
    <Object>.error Mensagens de erro
    Valores possíveis:
    • O sys_id do modelo de preferência de contato não está correto
    • O sys_id do conjunto de escalação não está correto
    • Tentativas de contato já existem

    Tipo de dados: Cadeia de caracteres

    <Object>.aviso Mensagem de aviso.

    Tipo de dados: Cadeia de caracteres

    Este exemplo aplica um modelo de preferência de contato à Central de serviços - conjunto de escalação padrão. O objeto de retorno está vazio porque não há erros ou avisos.

    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));

    Saída:

    {}

    OnCallContactPreTemplate - deleteContactPreferenceAttempts(cadeia de caracteres escalationSetSysId)

    Exclui todas as preferências de contato associadas a um conjunto de escalação.

    Todos os registros de tentativa de contato do conjunto de escalação são excluídos da tabela Preferência de contato de turno [cmn_rota_contact_preference].

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    EscalationSetSysId Cadeia de caracteres Sys_id do conjunto de escalação na tabela Conjunto de escalação de turno [cmn_rota_escalation_set].
    Tabela 5. Retornos
    Tipo Descrição
    Nenhum(a)

    Este exemplo exclui todas as preferências de contato associadas à Central de serviços - conjunto de escalação padrão.

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