Criar um modal de integração

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 5 min. de leitura

    • Crie seus próprios modais de integração para apresentar aos usuários uma nova experiência ou aplicação.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Tudo > Serviços de adoção > Criar orientação.
    2. Para criar seu modal de integração, faça o seguinte:
      1. No formulário, preencha os campos.
        Tabela 1. Formulário de orientação
        Campo Descrição
        Ordem Ordem que a orientação exibe. O número mais baixo é exibido primeiro e o próximo número cronológico vem em seguida.
        Nome Nome da experiência de integração.
        Tipo Tipo de orientação que aparece na IU. Selecione Modal.
        Funções Funções para esta orientação.
        Aplicação Aplicação para a orientação.
        Status Status da orientação.
        Ativo Selecione para habilitar ou desabilitar a orientação.
      2. Selecione Enviar.
    3. Para iniciar um modal de integração depois de criado, faça o seguinte:
      1. Crie um client script no UIB.
      2. No snippet de código, insira api.emit('SN_HELP#GUIDANCE_START_REQUESTED',{guidanceId:"ID"});
      3. Substitua o ID pelo sys_id da orientação modal a ser aberta.
      4. Salve a página.
      5. Selecione Corpo no painel esquerdo da página do UIB.
      6. No painel direito, selecione a guia Eventos.
      7. Em Eventos expedidos, selecione Adicionar.
      8. No nome do evento, adicione SN_HELP#GUIDANCE_START_REQUESTED e atribua um nome ao rótulo.
      9. Selecione Save (Salvar).
    4. Para criar etapas de orientação de ajuda integrada, faça o seguinte:
      1. Selecione sua orientação na lista Orientações.
        test2 é exibido na lista de Orientações.
      2. Na lista relacionada Etapas de orientação da ajuda, selecione Novo.
        A lista de etapas de orientação de ajuda do test2 é exibida.
      3. No formulário, preencha os campos.
        Tabela 2. Formulário Etapa de orientação de ajuda
        Campo Descrição
        Nome Nome da sua orientação.
        Layout Layout selecionado da orientação.
        • Vídeo
        • Imagem
        • Texto
        • Pergunta
        • Imagem e texto
        • Imagem e pergunta
        Ordem Ordem que a orientação exibe. O número mais baixo é exibido primeiro e o próximo número cronológico vem em seguida.
        Rótulo de Ação Rótulos de botão que permitem ao usuário navegar no modal de orientação.
        Aplicação Escopo da aplicação para a orientação. Esta orientação se aplica ao escopo Global.
        Orientação A orientação à qual esta Etapa de Orientação de Ajuda se aplica.
      4. Selecione Enviar.
    5. Para criar conteúdos de ajuda para as etapas de orientação de ajuda, faça o seguinte:
      1. Selecione sua etapa de orientação de ajuda na lista relacionada.
        A lista de etapas de orientação de ajuda do test2 é exibida.
      2. Na lista relacionada Conteúdo da Ajuda, selecione Novo.
        A lista relacionada de conteúdos de ajuda é exibida.
      3. Nota:
        Os campos de formulário são diferentes para cada tipo de orientação. Consulte o formulário correto para sua orientação.
        No formulário de texto, preencha os campos.
        Tabela 3. Formulário de texto de conteúdo de ajuda
        Campo Descrição
        Título Título do conteúdo de ajuda.
        Legenda Legenda exibida no modal do conteúdo de ajuda na IU.
        Tipo Tipo de orientação selecionado.
        Aplicação Escopo da aplicação para a orientação.
        Etapa de orientação Etapa de orientação de ajuda à qual este conteúdo de ajuda está associado. Por exemplo, Introdução/boas-vindas, Menu Todos e Histórico.
        Padrão Conteúdo de ajuda que é o padrão para a etapa de orientação.
        Rodapé Rodapé exibido no modal do conteúdo de ajuda na IU.
        Fornecer HTML personalizado HTML personalizado para o conteúdo de ajuda.
        Texto Texto exibido no modal do conteúdo de ajuda na IU.
      4. Clique em Enviar.
      5. No formulário de vídeo, preencha os campos.
        Tabela 4. Formulário de vídeo de conteúdo de ajuda
        Campo Descrição
        Título Título do conteúdo de ajuda.
        Legenda Legenda exibida no modal do conteúdo de ajuda na IU.
        Tipo Tipo de orientação selecionado.
        Link de vídeo O link para o seu vídeo ser exibido.
        Nota:
        Somente o YouTube e o Vimeo são compatíveis.
        Aplicação Escopo da aplicação para a orientação.
        Etapa de orientação Etapa de orientação de ajuda à qual este conteúdo de ajuda está associado. Por exemplo, Introdução/boas-vindas, Menu Todos e Histórico.
        Padrão Conteúdo de ajuda que é o padrão para a etapa de orientação.
        Rodapé Rodapé exibido no modal do conteúdo de ajuda na IU.
        Fornecer HTML personalizado HTML personalizado para o conteúdo de ajuda.
        Texto alternativo Texto alternativo que é exibido no modal do conteúdo de ajuda na IU.
      6. Clique em Enviar.
      7. No formulário de imagem, preencha os campos.
        Tabela 5. Formulário de imagem de conteúdo de ajuda
        Campo Descrição
        Título Título do conteúdo de ajuda.
        Legenda Legenda exibida no modal do conteúdo de ajuda na IU.
        Tipo Tipo de orientação selecionado.
        Imagem A imagem selecionada para exibir em sua orientação.
        Aplicação Escopo da aplicação para a orientação.
        Etapa de orientação Etapa de orientação de ajuda à qual este conteúdo de ajuda está associado. Por exemplo, Introdução/boas-vindas, Menu Todos e Histórico.
        Padrão Conteúdo de ajuda que é o padrão para a etapa de orientação.
        Rodapé Rodapé exibido no modal do conteúdo de ajuda na IU.
        Fornecer HTML personalizado HTML personalizado para o conteúdo de ajuda.
        Fornecer link de imagem O link da imagem é exibido na orientação.
        Texto alternativo Texto alternativo que é exibido no modal do conteúdo de ajuda na IU.
      8. Clique em Enviar.
      9. No formulário de pergunta, preencha os campos.
        Tabela 6. Formulário de pergunta de conteúdo de ajuda
        Campo Descrição
        Título Título do conteúdo de ajuda.
        Legenda Legenda exibida no modal do conteúdo de ajuda na IU.
        Tipo Tipo de orientação selecionado.
        Aplicação Escopo da aplicação para a orientação.
        Etapa de orientação Etapa de orientação de ajuda à qual este conteúdo de ajuda está associado. Por exemplo, Introdução/boas-vindas, Menu Todos e Histórico.
        Padrão Conteúdo de ajuda que é o padrão para a etapa de orientação.
        Rodapé Rodapé exibido no modal do conteúdo de ajuda na IU.
        Fornecer HTML personalizado HTML personalizado para o conteúdo de ajuda.
      10. Selecione Enviar.
      11. Selecione Novo no campo relacionado Pergunta de ajuda.
        Tabela 7. Formulário de pergunta de ajuda
        Campo Descrição
        Pergunta O conteúdo da pergunta a ser adicionada à orientação.
        Ordem A ordem da pergunta na orientação.
        Variante A variante da pergunta.
        • A opção Rádio é selecionada para perguntas com apenas uma resposta.
        • A caixa de seleção está marcada para perguntas com várias respostas.
        Aplicação Escopo da aplicação para a orientação.
        Conteúdo da Ajuda O Conteúdo de Ajuda para o qual a pergunta foi criada.
        Obrigatório A pergunta é Obrigatória quando selecionada.
      12. Selecione Novo no campo relacionado Respostas de ajuda para criar respostas.
        Tabela 8. Formulário de resposta de ajuda
        Campo Descrição
        Rótulo O rótulo da resposta.
        Valor O valor da resposta.
        Ordem A ordem da resposta.
        Aplicação Escopo da aplicação para a orientação.
        Pergunta A pergunta para a qual a resposta foi criada.
      13. Selecione Enviar.
    6. Crie qualquer orientação adicional que você deseja criar sua experiência de integração.
    7. Quando terminar de criar sua orientação de integração, confirme se o status da sua orientação está definido como Publicado no formulário de orientação.
    8. No formulário Orientação, selecione Atualizar.