SNIPPET

Esta página de ajuda é para Desktop Studio. Estas informações também estão disponíveis para Studio.

Icon of SNIPPET: code brackets

Permite adicionar código personalizado ao seu script.

Fazer chamadas de REST API a partir de uma ação SNIPPET é fortemente desencorajado. Em vez disso, use a REST API ação ou Integration Hub. Se sua API for SOAP ou retornar XML, revise as recomendações de como minimizar o impacto no seu sistema ao fazer Chamadas de API a partir do SNIPPET.

Dependências

  • O código usado nesta ação deve ser escrito em Snippet, uma linguagem de script interna desenvolvida para NiCE CXone. O Studio guia de referência técnica fornece informações detalhadas sobre scripts em snippets.
  • Os atributos de objetos de dados dinâmicos não podem ser nomeados __type (com dois sublinhados). Essa palavra é reservada para uso ao analisar JSON de objetos dinâmicos.
  • Você pode fazer Chamadas de API usando a ação Snippet. No entanto, este não é o método recomendado para fazer Chamadas de API em seus Scripts. Se você as fizer dessa forma, certifique-se de entender os riscos e as práticas recomendadas.
  • O tamanho máximo de matrizes em Studio é de 63 milhões de elementos. Exceder esse tamanho de matriz resulta no seguinte erro na variável __err em um rastreamento de script: Array index out of bounds. The current array index ([index]) exceeds the maximum allowed index (63000000). Quando o tamanho máximo da matriz é excedido, o script segue o ramo de Erro da ação SNIPPET. Se o ramo de Erro não estiver conectado, o script continua a ser executado, porém sem as informações da matriz. Você pode configurar scripts para notificá-lo quando o tamanho máximo da matriz tiver sido excedido, adicionando uma ação EMAIL ao ramo de Erro da ação SNIPPET. Por fim, você pode adicionar uma lógica no ramo de Erro para continuar o script. Observe que ele continuará sem as informações da matriz.
  • O tamanho máximo da resposta em NiCE CXone é 32 KB. O limite é estritamente aplicado para evitar instabilidade e interrupções no cluster. Studio aplica esse limite ao salvar o script, mas Desktop Studio não aplica. Se possível, use a ação REST API ação ou Integration Hub em vez da ação SNIPPET para fazer Chamadas de API. Eles têm o mesmo limite, mas podem suportar uma carga maior. Se você precisar usar a ação SNIPPET, siga estas dicas para reduzir o tamanho dos dados retornados:

    • Filtrar os dados na resposta da API: Por exemplo, se você estiver usando a API de reporting NiCE para obter contatos, você pode filtrar os resultados pelo startDate e endDate do contato. Essa Chamada de API também permite retornar e limitar uma contagem de parte superior de itens. Consulte a documentação da API que acompanha sua integração de script para determinar quais filtragens você pode usar.

    • Atualize a solicitação de API para retornar somente os dados de que você precisa: Por exemplo, se você estiver usando a API de reporting NiCE para obter contatos, você pode usar os campos contactId ou agentId para retornar somente os dados relevantes. Consulte a documentação da API fornecida com a integração de script para determinar quais limites de dados você pode usar.

    • Compilar middleware: Se você não puder realizar nenhuma das opções anteriores, compile um middleware que realize a filtragem com base em critérios personalizados definidos por você. Se fizer isso, certifique-se de que o middleware não adicione latência à chamada.

  • Cada loop FOR, FOREACH ou REPEAT loop dentro de um SNIPPET é protegido por um limite de tempo de 500 ms. Se um loop exceder esse limite, a ação SNIPPET segue a ramificação de erro com o erro Too much time has elapsed. Isso evita o uso excessivo de recursos do sistema para loops fora de controle. O limite de tempo de 500 ms aplica-se somente ao trabalho do lado do script, incluindo atribuições, operações aritméticas, condições, acesso a matrizes, entre outros. Não se aplica à execução de ponta a ponta do código do snippet. Por exemplo, o tempo de espera por um sistema externo, como uma chamada de API REST ou de banco de dados, não conta para esse limite.

Tipos de script suportados

The icon for a Generic script type - a rectangle with < and > symbols inside it.

The icon for the Email script type - a large @ symbol in a diamond.

O ícone para o tipo de script Chat - um balão de chat com reticências dentro (...), em formato de diamante.

O ícone do tipo de script Telefone - um fone de telefone de estilo antigo com linhas curvas indicando som saindo dele.

O ícone do tipo de script Voicemail - um símbolo que se parece com uma fita cassete - dois círculos em uma linha horizontal.

O ícone do tipo de script Item de trabalho - uma folha de papel com um canto dobrado e uma lista com marcadores.

O ícone do tipo de script SMS - um smartphone com um balão de bate-papo saindo dele.

O ícone do tipo de script Digital - um monitor de computador com um smartphone ao lado.

Genérico

E-mail Chat Telefone Correio de voz Item de trabalho SMS Digital

Propriedades de entrada

Estas propriedades definem dados que a ação usa durante a execução.

Propriedade

Descrição

Legenda

Insira uma frase curta que identifique exclusivamente esta ação no script. A legenda aparece na tela do script no ícone da ação. O padrão é o nome da ação.

Dados

Contém o código personalizado adicionado na janela do Snippet editor. Isso pode incluir vários ASSIGN e DYNAMICcomandos, instruções variadas de controle de fluxo, e funções integradas e definidas pelo usuário.

MaxStringSize

Define o tamanho máximo da string para todos os comandos na propriedade Data. As Opções são: limite 2k, limite 4k, limite 8k, limite 16k, limite 32k. Esse limite se aplica a respostas de integração com API REST e SOAP.

Condições do ramo de resultado

As condições de ramificação de resultado permitem que você crie ramificações no seu script para tratar diferentes resultados quando uma ação é executada.

Condição

Descrição

Padrão

Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.

OnError

Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem.

Use cuidado ao fazer Chamadas de API do SNIPPET

Não é recomendável criar Chamadas de API dentro de um Snippet. Isso pode causar problemas graves de desempenho que afetam o atendimento de contatos e impactam negativamente seu locatário. Para uma experiência mais segura e confiável, use um dos métodos preferenciais a seguir.

Há dois casos em que fazer chamadas pelo SNIPPET é o método que você deve usar: se você estiver se conectando a um serviço web SOAP ou se suas Chamadas de API incluírem XML. Se você precisar usar o SNIPPET para Chamadas de API:

  • Limite os tempos limite nas suas Chamadas de API. Uma recomendação geral é que os tempos limite não sejam superiores a dois segundos. Os tempos limite padrão podem ser mais longos, portanto, verifique sempre os tempos limite para garantir que eles não excedam esse máximo. Se você constatar que tempos limite mais longos são necessários, ajuste seu serviço web, se possível, para melhorar seus tempos de resposta.
  • Seja extremamente cauteloso com a lógica de Loop. A combinação de Loops e tempos limite longos agrava o impacto potencial no seu sistema.
  • O tamanho máximo da resposta em NiCE CXone é 32 KB. O limite é estritamente aplicado para evitar instabilidade e interrupções no cluster. Studio aplica esse limite ao salvar o script, mas Desktop Studio não aplica. Se possível, use a ação REST API ação ou Integration Hub em vez da ação SNIPPET para fazer Chamadas de API. Eles têm o mesmo limite, mas podem suportar uma carga maior. Se você precisar usar a ação SNIPPET, siga estas dicas para reduzir o tamanho dos dados retornados:

    • Filtrar os dados na resposta da API: Por exemplo, se você estiver usando a API de reporting NiCE para obter contatos, você pode filtrar os resultados pelo startDate e endDate do contato. Essa Chamada de API também permite retornar e limitar uma contagem de parte superior de itens. Consulte a documentação da API que acompanha sua integração de script para determinar quais filtragens você pode usar.

    • Atualize a solicitação de API para retornar somente os dados de que você precisa: Por exemplo, se você estiver usando a API de reporting NiCE para obter contatos, você pode usar os campos contactId ou agentId para retornar somente os dados relevantes. Consulte a documentação da API fornecida com a integração de script para determinar quais limites de dados você pode usar.

    • Compilar middleware: Se você não puder realizar nenhuma das opções anteriores, compile um middleware que realize a filtragem com base em critérios personalizados definidos por você. Se fizer isso, certifique-se de que o middleware não adicione latência à chamada.

Dicas e truques

Snippet editor Janela

A janela do Snippet editor é aberta quando você dá um duplo clique em uma ação Snippet.

A janela Snippet editor na ação Snippet tem duas guias. Ambas as guias permitem que você crie os mesmos tipos de código. Você pode mudar de um lado para outro entre as guias e editar seu código em qualquer um dos locais. As guias são:

  • A guia Text View. Este é um campo de texto livre no qual você pode digitar seu código manualmente.
  • O guia Tree View. Esta é uma interface gráfica que você pode usar para criar seu código. Esta guia tem uma lista na qual você pode selecionar palavras-chave para adicionar instruções ao Snippet.

Exemplo de script

Este é um exemplo para mostrar como essa ação pode ser usada em Scripts. Ele não é voltado para um script inteiro. Pode ser necessário um script adicional.

Neste exemplo simples, o código no Snippet é usado para testar se um cliente em potencial pode ser criado usando informações de um sistema de terceiro.

Um script com duas ações de SNIPPET.

Baixe este script.