Melhores práticas do OmniScript

Lógica e processo de negócios

As práticas recomendadas de lógica e processo de negócios incluem:

• Use nomes exclusivos para elementos do OmniScript e nós de resposta do Mapeador de dados do OmniStudio.
• Identifique elementos reutilizáveis criando um contorno de todo o OmniScript.
• Documente o propósito de um elemento na propriedade Notas internas do elemento.
• Evite alterações no nome do elemento após a implantação na produção. Quando isso for inevitável, aplique as alterações de nome sempre que o elemento for mencionado.
• Não atribua um ContextId no OmniScript. ContextId de um OmniScript é uma chave reservada que atribui um ID de registro do URL.
• Quando os processos são repetíveis em vários OmniScripts, crie um OmniScript reutilizável e adicione-o aos OmniScripts pai apropriados. Consulte Integrar um OmniScript em outro OmniScript.
• Tente impor os dados e as validações necessários na etapa atual, em vez de no final de um formulário. Isso ajuda os usuários a corrigir suas entradas imediatamente, em vez de procurar validações ou erros no final e rastrear novamente suas etapas para corrigir cada uma.
• Quando possível, divida tarefas complexas em um aplicativo usando vários OmniScripts. Use OmniScripts com FlexCards, se necessário. Criar um OmniScript grande com várias etapas pode prejudicar o desempenho e a experiência do usuário.

Interface do usuário

Os OmniScripts usam Componentes da Web Lightning para definir o estilo para elementos individuais e para o OmniScript em si.

As práticas recomendadas incluem:

• Aplicar estilo global. Para obter mais informações, consulte Estilos personalizados para OmniScripts.

Acessibilidade

As práticas recomendadas de acessibilidade incluem:

• No momento, os blocos de edição configurados no modo de tabela em OmniScripts não são compatíveis com leitores de tela. Se você usa um leitor de tela, recomendamos usar FlexCards em vez de OmniScripts. Em FlexCards, você pode usar tabelas de dados ou tabelas de dados do Lightning compatíveis com leitores de tela. Consulte Mostrar dados em uma tabela em um FlexCard e um componente da Web Lightning – Tabela de dados.

Segurança

As práticas recomendadas de segurança de dados incluem:

• Para garantir a segurança dos dados e manter a conformidade com os controles de acesso de criptografia do Salesforce, verifique sempre se o usuário tem a permissão Visualizar dados criptografados antes de exibir ou processar valores descriptografados de campos criptografados.

Principios de design da experiência do usuário

Os princípios de design de UX incluem:

• Reduza o número de campos em que o usuário deve inserir informações preenchendo previamente os campos usando dados contextuais. Para obter mais informações, consulte Definir valores em um OmniScript.
• Para evitar a carga cognitiva, considere cuidadosamente como você divide os processos. Etapas curtas demais que contenham apenas um número mínimo de elementos podem sobrecarregar o usuário tão facilmente quanto etapas grandes com vários elementos.
• Oriente o usuário criando texto de ajuda contextual e ordenando de modo lógico os campos de entrada.
• Certifique-se de que os blocos aninhados recursivos em um OmniScript não excedam 10.

Fatores de desempenho

Há um conjunto de práticas recomendadas para desempenho no lado do cliente e desempenho no lado do servidor.

As práticas recomendadas do lado do cliente incluem:

• Reduza visualizações condicionais, campos de mesclagem e fórmulas quando possível.
• Acelere a aplicação de respostas cortando o JSON de resposta. Para obter mais informações, consulte Manipular JSON com as Propriedades de Transformações de envio/resposta.
• Remova espaços de nomes de elemento para melhorar o tempo de carregamento do OmniScript.
• Reduza o número de elementos no script. Tente limitar um único OmniScript a um máximo de 750 elementos.
• Execute a lógica no servidor quando possível, por exemplo, lógica condicional em procedimentos de integração e fórmulas em Mapeadores de dados.
• PDFs maiores que 250 KB são gerados lentamente. PDFs maiores que 1 MB podem levar vários minutos para serem gerados e, às vezes, expiram.

As práticas recomendadas no lado do servidor incluem:

• Reduza o tamanho da carga útil de uma solicitação cortando a solicitação JSON. Para obter mais informações, consulte Manipular JSON com as Propriedades de Transformações de envio/resposta.
• Não crie OmniScripts com componentes da Web Lightning maiores que 4 MB. Na visualização, os OmniScripts maiores que 4 MB mostram um erro para indicar que o OmniScript está inativo ou não está implantado. Baixe o OmniScript LWC para verificar seu tamanho.
• Reduza as visitas ao servidor usando Procedimentos de integração sempre que houver várias ações entre as etapas. Execute procedimentos de integração de modo assíncrono habilitando a propriedade fire and forget.
• Remova dados desnecessários cortando a saída de extração do Data Mapper.
• Ao criar recursos com o OmniStudio, lembre-se dos limites do regulador do Apex. Esses limites garantem que um único processo não controle recursos compartilhados. Durante o desenvolvimento, use registros de depuração para rastrear e gerenciar limites do controlador, garantindo que seu desenvolvimento seja eficiente e não exceda os limites do Salesforce durante a execução. Consulte Limites do regulador do Apex.

  Para monitorar como os limites do regulador são usados por componentes do OmniStudio durante a execução, colete registros de depuração do Apex para uma transação, por exemplo, ativar um OmniScript, iniciar um FlexCard ou executar uma etapa em um OmniScript. Para coletar registros de depuração do Apex, crie um sinalizador de rastreamento e defina-o para o usuário que executa processos do OmniStudio. Consulte Configurar registro de depuração.

  Quando você executa um OmniScript, Procedimento de integração ou Mapeador de dados, os logs de depuração capturam todas as transações e fornecem percepções sobre o uso dos limites do regulador.

Casos de uso de implementação

• Salve registros selecionados do FlexCard Datatable em um OmniScript.
  1. Crie um FlexCard e adicione um elemento Datatable.
     

     Nota

     Crie seu FlexCard e adicione o componente de tabela de dados necessário no FlexCard.

  2. Configurar o ouvinte de evento na configuração do FlexCard:
     1. Vá para a guia de configuração do FlexCard.
     2. Adicione um ouvinte de evento com estas configurações:
        • Tipo de evento: Evento personalizado
        • Nome do evento: selecionar
        • Rótulo da ação: Escolha um rótulo que você prefere.
        • Tipo de ação: Atualizar OmniScript
        • Nó pai: OsDataNode

        Essa configuração garante que você esteja atualizando um nó específico em uma matriz no OmniScript. Isso ajuda a rastrear e atualizar os registros selecionados. Você pode substituir registros por qualquer nome de nó da matriz conforme necessário.

        

        Nota Atualize o nó correto no OmniScript para um tratamento de dados preciso.
  3. Adicione parâmetros de entrada com estas configurações:
     • Código: Escolha a marca JSON apropriada para o registro selecionado.
     • Valor: {action.result}

     Essa configuração garante que toda a linha de dados seja incluída, junto com a variável selectrow, que indica se o registro está selecionado ou não (verdadeiro ou falso).

     

     Nota Os parâmetros de entrada devem corresponder aos nomes das variáveis do OmniScript para garantir que os dados sejam transferidos corretamente.
  4. Se necessário, adicione condições. Por exemplo, use action.result.selectrow para determinar se o registro deve ser adicionado ou removido.

     Essa condição é opcional. Se você precisar de ações diferentes para registros selecionados e não selecionados, poderá criar dois ouvintes de evento com condições diferentes para cada caso. Você pode personalizar ainda mais a lógica adicionando mais condições com base nos requisitos do seu fluxo de trabalho.

Configuração

Projetar OmniScripts com configurações específicas às vezes pode levar a comportamentos indesejados nos sites em que eles estão incorporando. Isso pode ocorrer devido à maneira como os OmniScripts são projetados ou devido a uma combinação de fatores fora do escopo do OmniStudio. Alguns problemas conhecidos e práticas recomendadas relacionadas são descritos aqui.

As práticas recomendadas de configuração incluem:

• Ao usar um elemento Ação, Definir valores ou Mapeador de dados para preencher dados em um bloco de edição em um OmniScript, a duplicação de dados poderá ocorrer se a caixa de seleção Mesclar dados salvos JSON para a versão atualizada estiver marcada na seção Salvar opções e se um usuário retomar uma sessão salva. Para evitar isso, adicione um sinalizador para rastrear a execução do elemento Ação, Mapeador de dados ou Definir valores e inclua uma condição na seção Visualização condicional para continuar apenas se o sinalizador for falso. Por exemplo, você pode usar um sinalizador com um elemento Definir valores para evitar duplicação de dados, conforme mostrado.
  
• Não há suporte para tabelas dentro de blocos de texto.