Conceito
Para permitir a busca em outras fontes de pesquisa, será disponibilizado uma aba da Central de Ajuda que realizará a consulta em uma fonte customizada. É possível 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 (uma) fonte de dados customizada. 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.
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:
- {{linhaproduto}}
- {{segmento}}
- {{versao}}
- {{modulo}}
- {{rotina}}
- {{texto}}
- {{idioma}}
No arquivo Datasul_framework.properties incluir as seguintes propriedades:
- Datasul.help.baseurl - URL base para ser concatenada ao identificador da pagina e montar o link que será exibido na tela da central;
- Datasul.help.initialur - URL da busca inicial, a busca que será realizada assim que a Central de Ajuda for acessada;
- Datasul.help.advancedurl - URL da busca avançada, quando é utilizado o campo de pesquisa na central de ajuda;
- Datasul.help.seemoreurl - URL que será utilizada para a construção do link 'veja mais'
- Datasul.help.urlfield - Indica o campo do JSON de retorno que contém o identificador da pagina destino. Esta informação será concatenada à URL base para formar o link.
- Datasul.help.titlefield - Indica o campo do JSON de retorno que contém o titulo a ser exibido para o link no corpo da aba customizada.
- Datasul.help.titlelimit - Indica a quantidade de caracteres que o titulo do link terá
- Datasul.help.pagetitle - Indica o titulo da aba customizada
- Datasul.help.arrayname - Indica o nome do array que possui a lista de itens retornados no JSON.
No exemplo a seguir, realizamos uma configuração para acessar o conteúdo do youtube:
Datasul.help.baseurl=http://www.youtube.com.br/watch?v= Datasul.help.initialurl=https://www.googleapis.com/youtube/v3/search?part=id%2C+snippet&q={{linhaproduto}}&channelid=UChsYWCL7MFkDM4OsK7de8dw&type=video&maxResults=10&key=AIzaSyA-tg4sqTbd5ArqndIyb6jcpa1uEX8PBxo Datasul.help.advancedurl=https://www.googleapis.com/youtube/v3/search?part=id%2C+snippet&q={{linhaproduto}}+{{text}}&channelid=UChsYWCL7MFkDM4OsK7de8dw&type=video&maxResults=10&key=AIzaSyA-tg4sqTbd5ArqndIyb6jcpa1uEX8PBxo Datasul.help.seemoreurl=https://www.youtube.com/results?search_query={{linhaproduto}} Datasul.help.urlfield=id.videoId Datasul.help.titlefield=snippet.title Datasul.help.titlelimit=180 Datasul.help.pagetitle=teste customizado Datasul.help.arrayname=items
Resultado:
OBS: Para programas específicos, a documentação será aberta conforme o módulo cadastrado no cadastro de procedimentos ("bas_procedimento") que foi relacionado ao programa específico em questão no cadastro de programas ("bas_prog_dtsul").