Guia de Especificação da Central de Ajuda TOTVS

Guia de Especificação da Central de Ajuda TOTVS

Introdução

A Central de ajuda substitui o Help OnLine dos softwares  da TOTVS. Ela foi construída pelo TOTVS HTML Framework  disponibilizada no endereço https://help.totvs.com que funciona segundo as especificações do guia.

Conceito da busca

A Central de Ajuda será aberta com a busca baseada na linha de produto, segmento, versão/release, módulo e entrada de menu (rotina/action).

Na caixa de texto da central de ajuda o usuário será redirecionado para a busca centralizada da TOTVS que usa as mesmas fontes de informações.

Por se tratar de uma tecnologia OnLine, a Central de ajuda depende totalmente da conexão com a internet da estação do usuário.

A busca em cada fonte é feita de forma assíncrona, sem travar o acesso à central de ajuda enquanto as fontes não respondem as solicitações. Caso não seja possível conexão com alguma fonte de dados ou seja retornado algum erro como resposta, o erro é tratado e as outras fontes permanecerão acessíveis ao usuário.

A busca em cada fonte se divide basicamente em 3 pontos:

• Busca inicial

Busca executada no momento de abertura da central de ajuda. Essa busca levará em conta o contexto em que o usuário abriu a central de ajuda, verificando linha de produto, segmento, versão/release, módulo e entrada de menu (rotina/action).

• Link "Veja Mais"

Link exibido abaixo da lista de cada fonte. Deverá abrir uma página externa no navegador padrão do sistema operacional com a fonte em questão e alguns filtros de contexto.

Acionamento da Central de Ajuda

O produto deve abrir o navegador, nova aba ou nova janela na estação do usuários com definindo o endereço inicial como https://help.totvs.com

Internacionalização

A central de ajuda deverá ser internacionalizada seguindo as seguintes definições:

• Os textos da Central de Ajuda são apresentados de acordo com o idioma do navegador do usuário
• As fontes de buscas respeitarão as definições de internacionalização descritas no decorrer deste guia, nos tópicos de cada fonte de dados.

Definição das áreas

• Base de Conhecimento (artigos do Zendesk)
• TDN (páginas de documentos de referencia)
• YouTube (vídeos de How To)
• Consultoria Segmentos (páginas do space ConSeg do TDN)
• Customização (fonte do próprio cliente, seguindo especificações do tópico "Documentação de Específicos e Customizações" deste guia)

Definições básicas para todas fontes de busca

• Serão exibidos até 10 resultados de cada fonte.
• Cada resultado contém o título com o hiperlink dá página da fonte de pesquisa, assim, ao clicar em algum item do resultado da busca do TDN, por exemplo, será  abrir o navegador padrão do sistema operacional com o link do TDN.
• Abaixo dos resultados de cada fonte há um link com a descrição "Veja mais" que abrirá a página da fonte de busca aplicando a busca inicial (a busca adicional fornecida pelo usuário através da caixa de busca não será repassada para o link "Veja mais"). Por exemplo: Ao clicar em "Veja mais" da coluna do YouTube, será aberto no navegador a página do YouTube filtrando a playlist de How To.

Parametros para acionar a Central de Ajuda

Os parametros deverão ser adicionados ao endereço https://help.totvs.com como query string. Baseado nesses parametros a Central de Ajuda chamará as APIs do TDN, Zendesk e YouTube com o tratamento necessários para filtrar os resultados conform será explicado nesse documento.

Para os parametros de linha de produto e segmento deve-se utilizar os valores conforme as tabelas a seguir.

Linha de Produto

Segmento

Versão

Deve ser informado o release trocando o ponto por _  ou seja para versao 12.1.25 o parametro será 12_1_25.

Módulo e Rotina

Os parametros de módulo e entrada de menu (rotina/action) devem ser informados quando o contexto em que o usuário acionar a central de ajuda possuir essas informações.

Busca no TDN

Conceito API - TDN

A busca na fonte TDN será realizada segunda a API /rest/api/content/search documentada em https://developer.atlassian.com/cloud/confluence/rest/api-group-search/#api-api-search-get

A busca será feita utilizando a linguagem CQL do Confluence, documentada em: https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql

Usaremos os seguintes campos:

Busca inicial – TDN

A busca inicial do TDN será realizada com os seguintes filtros:

SPACE = [Linha de produto]

LABEL = documento_referencia OR LABEL = documento_de_referencia

LABEL = ( [Versão com Release] OR LABEL = [Versão sem release] OR LABEL= todas_versoes  )

LABEL = [Módulo]

LABEL = [Entrada de menu (rotina/action)]

LIMIT = 10
 
Retornará no máximo 10 resultados.

Os filtros de módulo e entrada de menu (rotina/action) só serão feitos quando o contexto em que o usuário abrir a central de ajuda possuir essas informações, caso contrário esses labels não serão passados na busca.

O filtro de versão deverá ser capaz de encontrar primeiro os conteúdos de páginas de documento de referencia publicados na release ou conteúdos do help do sistema. Os label de versão do conteúdo de help do sistema conterá apenas a versão maior, por exemplo, versao_12. Porém o label de versão de um conteúdo comum conterá o release completo, por exemplo: versao_12_1_5.

Caso a busca por documentos de referencia retorne menos de 6 resultados será realizada uma busca adicional por outras páginas. 

Para conseguir buscar os dois conteúdos, a busca de versão será feita utilizando o operador OR e filtrando as duas condições. Conforme exemplo abaixo:

( label = versao_12 or label = versao_12_1_5 or label=12_1_5 or label=todas_versoes) 

Exemplo 1.

Cenário: Usuário utilizando o Microsiga Protheus versão 12.1.4, módulo Faturamento executando a rotina Pedido de Vendas (MATA410) o usuário pressiona F1, o filtro da central de ajuda será:.

Exemplo 2.

Cenário: Usuário utilizando o Microsiga Protheus versão 12.1.4, módulo Faturamento após o login o usuário pressiona F1, o filtro da central de ajuda será:.

Exemplo 3.

Cenário: Usuário utilizando o Microsiga Protheus versão 12.1.4, antes de efetuar o login e selecionar o módulo, pressiona F1, o filtro da central de ajuda será:.

Tratamento do retorno da API – TDN

O retorno das chamadas será um JSON semelhante ao exemplo abaixo:
{
"results": [
{
"id": "557074",
"type": "page",
"title": "Relatórios MATR263/MATR264/MATR266",
"_links": {
"webui": "/pages/viewpage.action?pageId=557074",
"tinyui": "/x/EoAI",
"self": "http://tdn-homolog.totvs.com/rest/api/content/557074"
},
"_expandable": {
"metadata": "",
"operations": "",
"children": "",
"history": "/rest/api/content/557074/history",
"ancestors": "",
"body": "",
"version": "",
"descendants": "",
"space": "/rest/api/space/MP"
}
},
{
"id": "557072",
"type": "page",
"title": "OX100AIP - Item do Pedido de Venda na Matriz Enviada ao Pedido de Venda",
"_links": {
"webui": "/display/MP/OX100AIP+-+Item+do+Pedido+de+Venda+na+Matriz+Enviada+ao+Pedido+de+Venda",
"tinyui": "/x/EIAI",
"self": "http://tdn-homolog.totvs.com/rest/api/content/557072"
},
"_expandable": {
"metadata": "",
"operations": "",
"children": "",
"history": "/rest/api/content/557072/history",
"ancestors": "",
"body": "",
"version": "",
"descendants": "",
"space": "/rest/api/space/MP"
}
}
],
"start": 0,
"limit": 25,
"size": 2,
"_links": {
"self": "http://tdn-homolog.totvs.com/rest/api/content/search?LIMIT=10&cql=SPACE=MP%20and%20label=manufatura%20and%20label=%2712_1_4%27",
"base": "http://tdn-homolog.totvs.com",
"context": ""
}
}
O link será montado utilizando os campos title e webui (concatenado com a URL do TDN) de cada item do retorno recebido, conforme exemplo abaixo:
<a href="http://tdn.totvs.com/pages/viewpage.action?pageId=557074"> Relatórios MATR263/MATR264/MATR266</a>

Link "Veja Mais" – TDN

O link abrirá a página do TDN aplicando os filtros da Busca Inicial (SPACE + LABELS), menos o label de documento de referencia, conforme exemplo abaixo:

<a href="http://tdn.totvs.com/dosearchsite.action?cql=space=PROT and (label=versao_12 or label=versao_12_1_4 or label='12_1_4' or label=todas_versoes) and label=MATA410 and type=page order by lastModified desc, created desc">Veja Mais</a>

No exemplo acima, PROT é o ID da space Linha Microsiga Protheus. Desta forma serão exibidas as páginas da SPACE Linha Microsiga Protheus que possuirem os labels manufatura, versao_12, versao_12_1_14, 12_1_14, todas_versoes e MATA410

Internacionalização - TDN

Para linhas de produto diferente do Microsiga Protheus, a internacionalização será feita através do plugin do google translate.

O TDN possuirá o plugin de tradução instalado e a central de ajuda deverá ajustar a url dos links de acordo com a regra abaixo:

Se o idioma do produto for espanhol, os links do TDN deverão terminar com o seguinte trecho

#googtrans(pt|es)

http://tdn.totvs.com/display/PROT/TSPIJZ_DT_geracao_calculo_ocorrencia_inexistente_gfea032#googtrans(pt|es)

Se o idioma do produto for ingles, os links do TDN na central de ajuda deverão terminar com o trecho

#googtrans(pt|en)

http://tdn.totvs.com/display/PROT/TSPIJZ_DT_geracao_calculo_ocorrencia_inexistente_gfea032#googtrans(pt|en)

Na linha de produto Microsiga Protheus existem artigos já publicados em outros temas e ainda está pendente de definição.

Busca no Zendesk

Conceito API - Zendesk

A busca na fonte Zendesk será realizada segundo a API /api/v2/help_center/articles/search.json documentada em {+}https://developer.zendesk.com/rest_api/docs/help_center/search

Usaremos os seguintes campos: Categoria (category) e label (label_names)

Busca inicial – Zendesk

A busca inicial do TDN deverá ser feita com os seguintes filtros:

CATEGORY = [Linha de produto]

LABEL_NAME = [Módulo] e [Action]

Os filtros de módulo e entrada de menu (rotina/action) só serão feitos quando o contexto em que o usuário abrir a central de ajuda possuir essas informações, caso contrário esses labels não serão passados na busca.

Exemplo 1.

Cenário: Usuário utilizando o Microsiga Protheus, módulo Faturamento, executando a rotina Pedido de Vendas (MATA410). O usuário pressiona F1, o filtro da central de ajuda será:

Exemplo 2.

Cenário: Usuário utilizando o Microsiga Protheus, módulo Faturamento após o login, executando a rotina Pedido de Vendas (MATA410). O usuário pressiona F1, o filtro da central de ajuda será:

Exemplo 3.

Cenário: Usuário utilizando o Microsiga Protheus, antes de efetuar o login e selecionar o módulo. O usuário pressiona F1, o filtro da central de ajuda será:

Tratamento do retorno da API – Zendesk

O retorno das chamadas será um JSON semelhante ao exemplo abaixo:

{
"count": 1,
"next_page": null,
"page": 1,
"page_count": 1,
"per_page": 25,
"previous_page": null,
"results": [
{
"id": 115010704247,
"url": "https://totvssuporte.zendesk.com/api/v2/help_center/pt-br/articles/115010704247-KCS-Quais-s%C3%A3o-os-Benef%C3%ADcios-Qualitativo-e-Quantitativo-da-Metodologia-KCS.json",
"html_url": "https://atendimento.totvs.com/hc/pt-br/articles/115010704247-KCS-Quais-s%C3%A3o-os-Benef%C3%ADcios-Qualitativo-e-Quantitativo-da-Metodologia-KCS",
"author_id": 6625565768,
"comments_disabled": false,
"draft": false,
"promoted": false,
"position": 0,
"vote_sum": 0,
"vote_count": 0,
"section_id": 205996147,
"created_at": "2017-07-28T14:32:34Z",
"updated_at": "2017-08-14T00:14:00Z",
"name": "KCS - Quais são os Benefícios Qualitativo e Quantitativo da Metodologia KCS",
"title": "KCS - Quais são os Benefícios Qualitativo e Quantitativo da Metodologia KCS",
"body": "<p><strong>Dúvida</strong></p>\n<p>Quais são os Benefícios Qualitativo e Quantitativo da Metodologia KCS?</p>\n<p><strong> </strong></p>\n<p><strong>Solução</strong></p>\n<p>Os benefícios em adotar a metodologia KCS atingem a todos os stakeholders: <strong>Cliente</strong>, <strong>Analista</strong> e <strong>TOTVS</strong>.</p>\n<p><strong>Cliente<br /></strong><span class=\"wysiwyg-underline\">Qualitativo</span></p>\n<ul>\n<li>Agilidade na resolução do incidente;</li>\n<li>Aumenta a produtividade;</li>\n<li>Facilita a interação e navegação do cliente para seu autoatendimento</li>\n</ul>\n<p><span class=\"wysiwyg-underline\">Quantitativo</span></p>\n<ul>\n<li> Aumenta a taxa de resolução no primeiro contato;</li>\n<li>Pesquisa de satisfação dos clientes;</li>\n<li>Taxa de cumprimento de Atendimento;</li>\n<li>Frequência de visitas a base de conhecimento TOTVS.</li>\n</ul>\n<p><strong>Analista<br /></strong><span class=\"wysiwyg-underline\">Qualitativo</span></p>\n<ul>\n<li>Referência de conhecimento no negócio TOTVS;</li>\n<li>Feedback de seus pares;</li>\n<li>Sentimento de realização e contribuição;</li>\n<li>Sentimento de autonomia.</li>\n</ul>\n<p><span class=\"wysiwyg-underline\">Quantitativo</span></p>\n<ul>\n<li>Reduz o número de interações entre as áreas;</li>\n<li>Satisfação com o trabalho;</li>\n<li>Ampliação dos conhecimentos técnicos;</li>\n<li>Desenvolvimento de novos conhecimentos relacionados com suas competências.</li>\n</ul>\n<p><strong>TOTVS<br /></strong><span class=\"wysiwyg-underline\">Qualitativo</span></p>\n<ul>\n<li>Certificação;</li>\n<li>Melhora a satisfação do cliente (CSAT).</li>\n</ul>\n<p><span class=\"wysiwyg-underline\">Quantitativo</span></p>\n<ul>\n<li>Redução de ticket;</li>\n<li>Melhora do tempo médio na primeira resposta (FCR).</li>\n</ul>",
"source_locale": "pt-br",
"locale": "pt-br",
"outdated": false,
"outdated_locales": [],
"label_names": [
"kcs"
],
"snippet": "<em>teste</em>",
"result_type": "article"
}
]
}

O link deverá ser montado utilizando os campos title e html_url  de cada item do retorno recebido, conforme exemplo abaixo: 
<a href="https://atendimento.totvs.com/hc/pt-br/articles/115010704247-KCS-Quais-s%C3%A3o-os-Benef%C3%ADcios-Qualitativo-e-Quantitativo-da-Metodologia-KCS"> KCS - Quais são os Benefícios Qualitativo e Quantitativo da Metodologia KCS</a>

Link "Veja Mais" – Zendesk

O link abrirá a página da categoria da linha de produto no Zendesk, sem aplicar os filtros da Busca Inicial (Category, section. label_names).

Para filtrar o space basta colocar o ID da space antes de colocar os valores dos labels, conforme exemplo abaixo

<a href="https://centraldeatendimento.totvs.com/hc/pt-br/categories/204298608">Veja Mais</a>

Busca no Youtube

Conceito da API – You Tube

Será utilizada a API v3 do YouTube para busca na central de ajuda TOTVS. Links para documentação da API do YouTube: {+}https://developers.google.com/youtube/v3/docs/search/list?hl=pt-br 

Busca inicial – You Tube

A base de todas as busca será o canal TOTVS Soluções.

Será feita de forma incremental até atingir o máximo de 10 resultados na seguinte ordem:

1. vídeos com títulos que contenham How to e o nome da linha de produto e descrição que contenha a entrada de menu (rotina/action)
2. vídeos com títulos que contenham How to e o nome da linha de produto e descrição que contenha o módulo
3. vídeos com títulos que contenham How to e o nome da linha de produto

Tratamento de retorno da API - YouTube

Será retornado um JSON, onde deverá ser usado o campo TITLE e o campo VIDEOID para exibir um link dos vídeos na central de ajuda. A descrição do link deverá ser o campo TITLE e o link deverá ser montado concatenando a URL "https://www.youtube.com/watch?v=" + o VIDEOID de cada vídeo retornado no JSON Exemplo de retorno:

{
"baseUrl": "http://www.youtube.com.br",
"seeMoreUrl": "http://www.youtube.com.br/channel/UChsYWCL7MFkDM4OsK7de8dw/playlists?view=50&sort=dd&shelf_id=3",
"response": {
"items": [
{
"id": {
"videoId": "_a1jOPmYIRQ"
},
"snippet": {
"title": "HOW TO - Protheus - TOTVS MES - Integração de Produtos"
}
},
{
"id": {
"videoId": "SxRLVo50a3s"
},
"snippet": {
"title": "HOW TO PROTHEUS Transferência Entre Endereços WMS"
}
},
{
"id": {
"videoId": "oIzVRlC3t2A"
},
"snippet": {
"title": "HOW TO - Protheus - Novo Extrator Fiscal - Schedule"
}
},
{
"id": {
"videoId": "6HEYUbNjtQc"
},
"snippet": {
"title": "HOW TO - Protheus - Novo Extrator Fiscal - Manual"
}
},
{
"id": {
"videoId": "dMVjdCxJ0GE"
},
"snippet": {
"title": "HOW TO - Protheus - Tombamento automático de publicações"
}
}
]
}
}

De acordo com os exemplos acima, deverá ser construído um link com a seguinte estrutura:
 
<a href="https://www.youtube.com/watch?v=6HEYUbNjtQc">HOW TO - Protheus - Novo Extrator Fiscal - Manual</a>
Os pontos destacados acima devem ser pegos dinamicamente do JSON retornado pela API, o restante do conteúdo será estático.

 Link "Veja Mais" – You Tube

O link abrirá a página do playlist de How To.
Exemplo de Link:
<a href="https://www.youtube.com/channel/UChsYWCL7MFkDM4OsK7de8dw/playlists?view=50&sort=dd&shelf_id=3>Veja Mais</a>

Internacionalização - YouTube

Não será feita nenhuma alteração na central quanto a internacionalização da fonte YouTube.
Ao acessar um vídeo, o YouTube permite ativar a legenda do áudio em diversos idiomas. 

Documentação de Customização

Conceito

Para permitir a busca em fontes de pesquisa do próprio cliente, será disponibilizado uma aba da central de ajuda que realizará a consulta em uma fonte customizada. O cliente poderá configurar a URL de uma fonte própria como fonte de consulta, que receberá os parâmetros conforme dados do ambiente (linha de produto, segmento, versão, módulo, rotina). Será permitida a configuração de 1 fonte de dados customizada. A interface de customização deverá ficar disponível somente ao administrador no módulo de configuração de cada linha de produto. A chamada será feita via REST com requisições do tipo GET, o retorno deverá ser no formato JSON. 

Não será suportado nenhum tipo de autenticação.

Parametros para acionar a Central de Ajuda

O produto TOTVS que deseja disponibilizar a área customizada na Central de Ajuda deve criar uma opção de configuração dos parametros abaixo e adicionar ao endereço http://help.totvs.com junto com os parametros padrões apresentados anteriormente.

Parametros para o cliente configurar a customização

O cliente deverá configurar duas URL's. Uma para a busca inicial e outra para a busca adicional. Os parâmetros da chamada GET deverão estar entre chaves duplas {{}} e o conteúdo opcional entre colchetes duplos [[]]. O conteúdo opcional são os parâmetros que podem não ser passados pela aplicação de acordo com o contexto. Os parâmetros suportados são:

• {{productLine}}

• {{idSegment}}
• {{version}}
• {{codModule}}
• {{action}}
• {{lang}}

Os parâmetros de módulo e rotina poderão não existir dependendo do contexto em que a central de ajuda for aberta. Por isso, nesses parâmetros deverão ser utilizados os colchetes duplos, conforme exemplo abaixo.

Exemplo: http://tdn-homolog.totvs.com/rest/api/content/search?cql=SPACE=QUALQUER and label={{segmento}} and label={{versao}} [[and label={{modulo}}]] [[and label={{rotina}}]] &LIMIT=10

 Quando o parâmetro não for utilizado na central de ajuda, todo conteúdo entre os colchetes duplos deverá ser removido.

Busca Inicial – Customizado

A busca inicial deverá substituir na URL de busca inicial os parâmetros entre chaves duplas pelo seus respectivos valores, tratar a existência ou não dos parâmetros modulo e rotina e remover os caracteres de colchetes duplos (utilizados apenas para auxílio dos parâmetros modulo e rotina ).

Retorno da API - Customizado

A API deverá retornar obrigatoriamente os dados no formato JSON. Para tratamento do retorno, deverá ser disponibilizada na interface de configuração da fonte, uma área contendo as seguintes propriedades para o usuário configurar:

• Título da fonte de integração - pagetitle
  Título exibido na central de ajuda

• URL base - baseurl
  Será a URL inicial utilizada na criação dos links exibidos na central de ajuda

• URL - urlfield
  Deverá identificar o caminho do campo no JSON retornado que contém a URL. Será um complemento da URL Base na criação dos links. Caso o JSON contenha o caminho completo neste campo, a URL base não deverá ser preenchida. Deverá ser preenchido o caminho completo utilizado o caractere ponto entre cada campo.

• Título - titlefield
  Deverá identificar o caminho do campo no JSON retornado que contém o título que será exibido na Central de Ajuda. Deverá ser preenchido o caminho completo utilizado o caractere ponto entre cada campo.

A configuração exemplificada acima define que no JSON retornado, deverá ser percorrido o nó results e será criado um link para cada item deste nó utilizando como href a URL {+}http://tdn-homolog.totvs.com/+ concatenada com o campo webui e como descrição será utilizado o campo title (filho também do nó results), cortando em 50 caracteres.

Considerando que o JSON retornado foi

{
"results": [
{
"id": "557074",
"type": "page",
"title": "Relatórios MATR263/MATR264/MATR266",
"_links": {
"webui": "/pages/viewpage.action?pageId=557074",
"tinyui": "/x/EoAI",
"self": "http://tdn-homolog.totvs.com/rest/api/content/557074"
}
}
]
}

os parametros serão:

e será criado o seguinte link:

<a href="http://tdn-homolog.totvs.com/pages/viewpage.action?pageId=557074">Relatórios MATR263/MATR264/MATR266</a>

Link "Veja Mais" – Customizado

Para o link "Veja Mais" o cliente deverá configurar uma URL que será usada no href do link. Poderão ser utilizados pelo cliente os mesmos parâmetros da busca inicial e a aplicação deverá fazer a substituição dos parâmetros na abertura da tela.

Rotina de configuração – Customizado

A rotina de configuração deverá ser dividida em duas áreas e permitir a configuração dos seguintes campos:

• Configuração de acesso à API

·          URL Busca Inicial

·          URL "Veja Mais"

• Configuração de retorno da API

·          Título da fonte de integração (para exibição na central de ajuda)

·          URL base

·          Campo URL

·          Campo Title

Internacionalização - Customizado

Para internacionalização da fonte customizada, vamos disponibilizar o identificador {{ idioma }} para o cliente receber o idioma utilizado.
O identificador {{ idioma }} deverá ser substituido nas URL's configuradas da fonte customizada pela sigla do idioma, conforme abaixo