Guia de Especificação da Central de Ajuda


A Central de ajuda substitui o Help OnLine dos softwares da TOTVS. Ela deverá ser construída na tecnologia do ERP, segundo os padrões visuais e de busca contidos neste documento.
Por se tratar de uma tecnologia OnLine, deverá ser previsto no desenvolvimento da interface do ERP, um mecanismo de controle para a exibição de uma mensagem padronizada:

A central de ajuda irá realizar a busca em 4 fontes distintas conforme imagem abaixo:


A interface da Central de Ajuda será igual a exibida logo abaixo:


Na caixa de texto da central de ajuda o usuário poderá refinar a sua busca, assim, a pesquisa permanece a mesma, porém será utilizado o texto adicional na busca do TDN.
Em "Você precisa Saber", será colocada o resultado da busca do LMS da TOTVS.
Em "Ultimos Publicados", teremos 3 colunas de 3 fontes distintas: TDN, Youtube e Fluig Timeline.
Em "mais acessados" utilizaremos uma outra API de busca do TDN.
O resultado da busca, deverá ter um hiperlink que abrirá a pagina real de nossa documentação, assim, ao clicar em algum item do resultado da busca do TDN, deveremos abrir o Browse padrão da instalação do usuário, com o link (mensagem OPEN do SHELL do sistema operacional).

Busca na fonte TDN


A busca na fonte TDN será realizada segunda a API /rest/api/content/search documentada em (https://docs.atlassian.com/confluence/REST/latest/#d3e566) e o método GET.
A busca será feita em utilizando a linguagem CQL do Confluence, documentada em: https://developer.atlassian.com/confdev/confluence-rest-api/advanced-searching-using-cql
Onde usaremos os seguintes parâmetros:

  1. Space
  2. Label


Exemplo de query:
http:/myhost:8080/rest/api/content/search?cql=space=[linha de produto] and (label = "[version]" and label = "segmento"



Busca no Youtube

A busca do Youtube será feita, conforme a documentação da API https://developers.google.com/youtube/v3/docs/playlists/list. No caso especifico do Youtube, cada segmento será uma playlist do usuário "Tutoriais & Demonstrações". O ERP deverá manter a lista de Id por segmento.
Abaixo segue um exemplo de busca na playlist do Segmento de Varejo:
https://www.googleapis.com/youtube/v3/playlists?part=snippet&id=PLXa8l0dq5zRnVePPFrWgKbKutUXq020Sl&key=\{YOUR_API_KEY}