SNIPPET

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

Icon of SNIPPET: yellow 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

Um quadrado com uma linha saindo dele e indo em direção a três outros quadrados.

Icon of gray-green envelope

Ícone de balão de fala verde escuro

Icon of purple telephone handset

Ícone do símbolo de correio de voz na cor marrom-enferrujado, composto por dois círculos unidos por uma linha

Icon of pink document with lines of text

Ícone de um telefone celular verde com um balão de fala na tela

Icon of purple computer monitor with a mobile device overlapping its lower right corner

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

Adicionar 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.

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.

Tamanho máximo da string

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 de Ramificação 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.

Error

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.

Dicas e truques

Janela do editor Snippet

A janela do editor de Snippet é aberta quando você seleciona uma ação Snippet e clica em Abrir editor nas propriedades da ação. Você também pode clicar no ícone Icon of a rectangle with a horizontal line across it. no meio da ação quando ela estiver no script canvas.

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, as ações Snippet contêm declarações de objetos de dados dinâmicos e outras variáveis usadas no script. O Snippet com a legenda Analisar a Transcrição contém código que verifica se a transcrição é de um correio de voz. Se for um correio de voz, o script copia o corpo da mensagem da transcrição para uma variável. A variável que contém o corpo da mensagem é passada para a ação PLAY, que lê a mensagem usando conversão de texto em falaClosed Permite que os usuários insiram prompts gravados como texto e usem uma voz gerada por computador para falar o conteúdo..

Exemplo de script com várias Ações SNIPPET

Baixar este script.