SNIPPET

This help page is for Desktop Studio. This information is also available for CXone Studio.

Permite adicionar código personalizado ao seu script.

Dependencies

  • O código usado nesta ação deve ser escrito em Snippet, uma linguagem de script interna desenvolvida pela NICE CXone. O guia de referência técnica do Studio fornece informações detalhadas sobre criação de scripts em snippets.
  • 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 API usando a ação Snippet. O tamanho máximo da resposta é 32 KB. Isso é consistente com o limite de tamanho da resposta na ação REST API.  O limite é cumprido rigorosamente para evitar instabilidade e interrupções no conjunto. Se puder, use a action REST API em vez disso. Ela tem o mesmo limite, mas pode suportar uma carga mais pesada. Caso precise usar a ação SNIPPET, siga estas dicas para reduzir o tamanho das informações retornadas:
    • Filtre os dados na resposta da API. Por exemplo, se estiver usando a API de relatórios NICE para obter contatos, você pode filtrar os resultados pela startDate e endDate do contato. Esta chamada de API também permite retornar e limitar uma contagem máxima de itens. Consulte a documentação da API que acompanha a integração do script para determinar qual filtragem você pode usar.

    • Atualize a solicitação da API para retornar apenas os dados necessários. Por exemplo, se estiver usando a API de relatórios NICE para obter contatos, você pode usar os campos contactId ou agentId para retornar apenas dados relevantes. Consulte a documentação da API que acompanha a integração do script para determinar quais limites de dados você pode usar.

    • Se não puder seguir nenhuma das dicas anteriores, crie um middleware.

Supported Script Types

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.

The icon for the Chat script type - a chat bubble with an ellipsis inside (...), in a diamond shape.

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

The icon for the Voicemail script type - a symbol that looks like a cassette tape - two circles sitting on a horizontal line.

The icon for the Work Item script type-a piece of paper with one corner folded down and a bullet list on it.

The icon for the SMS script type - a smart phone with a chat bubble coming out of it.

The icon for the Digital script type - a computer monitor with a smartphone next to it.

Genérico

E-mail Chat Telefone Correio de Voz Item de Trabalho SMS Digital

Input Properties

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

Propriedade

Descrição

Caption

Insira uma frase curta que identifica exclusivamente esta ação no script. A legenda aparece na tela do script no ícone da ação. The default is the action name.

Data

Contém o código personalizado adicionado na janela do Snippet editor. Isso pode incluir vários comandos ASSIGN e DYNAMIC, diversos enunciados de controle de fluxo e funções incorporadas e definidas por usuário.

MaxStringSize

Define o tamanho máximo de string para todos os comandos na propriedade Data. As opções são: Limit2K, Limit4K, Limit8K, Limit16K, Limit32K. Este limite é aplicado às respostas de integrações com APIs Rest e SOAP.

Result Branch Conditions

Condições de ramal resultante permitem que você crie ramais no seu script para atender diferentes resultados quando uma ação é executada.

Condição

Descrição

Default

Caminho percorrido, a menos que o script atenda a uma condição que exige que ele percorra um dos outros ramais. Também é percorrido se os outros ramais da ação não estiverem definidos.

OnError

Caminho tomado quando a ação não é executada corretamente. Por exemplo, quando há um problema inesperado como conectividade ruim, erros de sintaxe e assim por diante. A variável _ERR, com o caractere sublinhado, deve ser preenchida com uma explicação condensada do problema.

Tips & Tricks

Snippet Editor Window

The Snippet Editor window opens when you double-click on a Snippet action.

A janela Snippet editor na ação Snippet tem duas guias. Ambas as guias permitem que você crie os mesmos tipos de código. É possível alternar entre as guias e editar o seu código em qualquer uma. As guias são:

  • A Guia visualização em texto. Este é um campo com um formato de texto livre onde você pode digitar o seu código manualmente.
  • A Guia visualização em árvore. Esta é uma interface gráfica que você pode usar para criar seu código. Esta guia possui uma lista a partir da qual você pode selecionar palavras-chave para adicionar instruções ao snippet.

Script Example

Este é um exemplo para mostrar como esta ação pode ser usada em scripts. Ele não é voltado para um script inteiro. Criação de script adicional pode ser necessária.

In this simple example, the code in the Snippet is used to test whether a prospect can be created using information from a third-party system.

A script with two SNIPPET actions.

Download this script.