Histórico da Página
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
...
- 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).
- Busca adicional
Busca executada quando o usuário pesquisar algum termo na barra de busca.
- Link "Veja Mais"
...
A cetral de ajuda deverá ser internacionaizada seguindo as seguintes definições:
- As strings fixas da central de ajuda deverão ser traduzidas de acordo com o idioma do sistema que acionou a central
- As fontes de buscas deverão respeitar as definições de internacionalização descritas no decorrer deste guia, nos tópicos de cada fonte de dados.
...
Em "Você precisa Saber", teremos 3 colunas as seguintes fontess:
- Blog da TOTVS
- Fluig - Comunidade #Segmento (de acordo com o segmento utilizado)
- Fluig - Comunidade @Consultoria Tributária
...
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).
| Âncora | ||
|---|---|---|
|
...
|
...
Atualmente o TDN não suporta o método REST que será utilizado nessa central, por isso, para o desenvolvimento poderá ser utilizado o TDN do seguinte endereço: http://tdn-homolog.totvs.com/. Posteriormente o TDN da TOTVS será atualizado e poderemos atualizar a url na central de ajuda.
Além disso, como ainda não fora disponibilizados tokens no ambiente Fluig da totvs, será necessário instalar um Fluig local para utilizar no desenvolvimento.
|
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:
Campo | Documentação |
SPACE | |
LABEL | |
TEXT |
...
A busca inicial do TDN deverá ser feita com os seguintes filtros:
SPACE = [Linha de produto]
LABEL = [segmento]
LABEL = [Versão / Release]*
LABEL = [Módulo]
LABEL = [Entrada de menu (rotina/action)]
LIMIT = 6
*O filtro de versão deve estar entre aspas. Exemplo '12'
Retornar no máximo 6 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.
Exemplo 1.
Cenário: Usuário utilizando o Microsiga Protheus versão 12.1.4, segmento Manufatura, módulo Faturamento executando a rotina Pedido de Vendas (MATA410) o usuário pressiona F1 e a central de ajuda deverá executar o GET conforme abaixo.
...
| theme | Eclipse |
|---|---|
| language | xml |
...
- Space
- Label
Exemplo de query:
http:/myhost:8080/rest/api/content/search?cql=
...
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
http://localhost:8044/rest/api/content/search?cql=SPACE=MP and label=manufatura and label='12_1_4'&LIMIT=10 |
...
A busca adicional no TDN deverá fazer todos os filtros da busca inicial e adicionar o filtro aplicado pelo usuário utilizando o campo TEXT e o operador contains ~
Antenção: O conteúdo a ser pesquisado deverá estar entre aspas.
Exemplo de chamada GET para busca adicional no TDN:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
http://localhost:8044/rest/api/content/search?cql=SPACE=MP and label=manufatura and label='12_1_4' and label=faturamento and label=mata410 and TEXT ~ 'pedido de venda matriz' &LIMIT=6 |
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"results": [
{
"id": "557074",
"type": "page",
"title": "Relatórios MATR263/MATR264/MATR266",
"_links": {
"webui": "/pages/viewpage.action?pageId=557074",
"tinyui": "/x/EoAI",
"self": "http://localhost:8044/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://localhost:8044/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://localhost:8044/rest/api/content/search?LIMIT=10&cql=SPACE=MP%20and%20label=manufatura%20and%20label=%2712_1_4%27",
"base": "http://localhost:8044",
"context": ""
}
} |
...
space=[linha de produto] and (label = "[version]" and label = "segmento"
Busca no Youtube
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<a href="http://tdn.totvs.com/pages/viewpage.action?pageId=557074"> Relatórios MATR263/MATR264/MATR266</a> |
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<a href="http://tdn.totvs.com/label/manufatura+12_1_4+faturamento+MATA410">Veja Mais</a> |
...
Pendente de definição
...
...
A busca do Youtube será feita, conforme a documentação da API
https://developers.google.com/youtube/v3/docs/
...
...
A busca inicial deverá buscar os 10 últimos vídeos da playlist do segmento utilizando o método playlistItems e filtrando pelo campo playlistID de acordo com a documentação abaixo.
https://developers.google.com/youtube/v3/docs/playlistItems/list?hl=pt-br
Os ID's de playlist devem ser usados conforme tabela abaixo:
Segmento | ID da playlist |
Agroindústria | PLXa8l0dq5zRn1TmeVghZIeVSLQdg9G95S |
Construção e Projetos | PLXa8l0dq5zRm2akf27RObAU1QjyG-gqI1 |
Distribuição e Logística | PLXa8l0dq5zRlqnISVp883CEZjCTCBdo6h |
Educacional | PLXa8l0dq5zRnHMKTeXiZFWqS1BskvHyWt |
Financial Services | PLXa8l0dq5zRkR_D1EPma_vYOO7jw2H8xs |
Jurídico | PLXa8l0dq5zRk8YB4St211088OuGt5qln2 |
Manufatura | PLXa8l0dq5zRnqaxgoQ9-VNm1On9DEp8ey |
Saúde | PLXa8l0dq5zRn-O2W-E6w9napYscdbDYAl |
Serviços | PLXa8l0dq5zRlvahGL7BlOBR61dY57_AJp |
Varejo | PLXa8l0dq5zRnVePPFrWgKbKutUXq020Sl |
Cross e Backoffice | PLXa8l0dq5zRm-endolCdVdmlfN0UEVjuy |
. 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
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
https://www.googleapis.com/youtube/v3/search?part=id%2C+snippet&q=Microsiga+Protheus+manufatura+12_1_4+faturamento+MATA410+texto+qualquer+do+usuario&channelId=UChsYWCL7MFkDM4OsK7de8dw &maxResults=10&key={YOUR_API_KEY} |
...
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:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"kind": "youtube#searchListResponse",
"etag": "\"Y3xTLFF3RLtHXX85JBgzzgp2Enw/EO1WEOXkxTksXPFCPYRfAtCZ1mE\"",
"nextPageToken": "CAoQAA",
"pageInfo": {
"totalResults": 32,
"resultsPerPage": 10
},
"items": [
{
"kind": "youtube#searchResult",
"etag": "\"Y3xTLFF3RLtHXX85JBgzzgp2Enw/sSo9Pomr2PmoRmxo3At8ldgmrzs\"",
"id": {
"kind": "youtube#video",
"videoId": "Ru7YQbMLgNg"
},
"snippet": {
"publishedAt": "2015-05-19T17:56:13.000Z",
"channelId": "UCliKm_T3MrZrCfow-HrvzEA",
"title": "Universo TOTVS 2015",
"description": "O Universo TOTVS é o principal evento da companhia e ocorre no dia 16 de junho (terça-feira), a partir das 8 horas non stop até às 19h, no Expo Center Norte, ...",
"thumbnails": {
"default": {
"url": "https://i.ytimg.com/vi/Ru7YQbMLgNg/default.jpg"
},
"medium": {
"url": "https://i.ytimg.com/vi/Ru7YQbMLgNg/mqdefault.jpg"
},
"high": {
"url": "https://i.ytimg.com/vi/Ru7YQbMLgNg/hqdefault.jpg"
}
},
"channelTitle": "Totvs",
"liveBroadcastContent": "none"
}
},
... |
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<a href="https://www.youtube.com/watch?v=Ru7YQbMLgNg">Universo TOTVS 2015</a> |
...
O link deverá abrir a página do You Tube com a playlist da busca inicial
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<a href="https://www.youtube.com/playlist?list=PLXa8l0dq5zRnVePPFrWgKbKutUXq020Sl">Veja Mais</a> |
...
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.
...
O blog TOTVS http://blog.totvs.com/ não possui uma API para realizar as buscas. Ele possui apenas um feed de notícias que pode ser acessado por segmento e retorna um XML com as últimas notícias do segmento. Por conta disso o Blog TOTVS realizará apenas a Busca Inicial. Quando um usuário filtrar algo na central de ajuda, esse filtro não será aplicado ao blog.
...
A busca inicial será feita utilizando o feed rss do segmento conforme modelo abaixo. http://blog.totvs.com/segmentos/nome-do-segmento/feed/
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
http://blog.totvs.com/segmentos/distribuicao-e-logistica/feed/ |
Atenção: conforme exemplo acima, segmentos que possuírem mais de uma palavra deverão ser concatenados com um hífen.
Os segmentos disponíveis no blog são:
Segmento |
Agroindústria |
Construção e Projetos |
Distribuição e Logística |
Educacional |
Financial Services |
Jurídico |
Manufatura |
Microempresas |
Saúde |
Serviços |
Varejo |
...
O blog não fará busca adicional.
...
O blog retorna um XML de acordo com o modelo abaixo.
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<rss xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:wfw="http://wellformedweb.org/CommentAPI/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:sy="http://purl.org/rss/1.0/modules/syndication/" xmlns:slash="http://purl.org/rss/1.0/modules/slash/" version="2.0">
<channel>
<title>TOTVS S/A » Distribuição e logística</title>
<atom:link href="http://blog.totvs.com/segmentos/distribuicao-e-logistica/feed/" rel="self" type="application/rss+xml"/>
<link>http://blog.totvs.com</link>
<description>Blog da TOTVS</description>
<lastBuildDate>Tue, 23 Jun 2015 20:02:09 +0000</lastBuildDate>
<language>pt-BR</language>
<sy:updatePeriod>hourly</sy:updatePeriod>
<sy:updateFrequency>1</sy:updateFrequency>
<generator>http://wordpress.org/?v=4.2.2</generator>
<image>
<url> http://blog.totvs.com/wp-content/uploads/2015/01/favicon1-54bfffc8v1_site_icon-32x32.png
</url>
<title>» Distribuição e logística</title>
<link>http://blog.totvs.com</link>
<width>32</width>
<height>32</height>
</image>
<item>
<title>Pagamento de frete eletrônico</title>
<link> http://blog.totvs.com/pagamento-de-frete-eletronico/
</link>
<comments> http://blog.totvs.com/pagamento-de-frete-eletronico/#comments
</comments>
<pubDate>Tue, 02 Jun 2015 13:58:50 +0000</pubDate>Link "Veja Mais" - Blog |
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<a href="http://blog.totvs.com/pagamento-de-frete-eletronico/">Pagamento de frete eletrônico</a> |
...
O link deverá abrir a página do Blog da TOTVS na página do segmento conforme exemplo abaixo.
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<a href="http://blog.totvs.com/segmentos/distribuicao-e-logistica">Veja Mais</a> |
...
A internacionalização no blog será feita da seguinte forma:
Quando o idioma do ERP for espanhol, deverá ser passado o parâmetro ?lang=es na chamada
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
http://blog.totvs.com/segmentos/construcao-e-projetos/?lang=es |
Para o idioma português é opcional o parâmetro ?lang=pt (português é o idioma padrão quando nenhum parâmetro for passado)
Quando o idioma for inglês o blog deverá ser consultado em português, pois não há tradução para inglês das páginas dos segmentos filtrados na central de ajuda.
...
O Fluig será exibido em 3 diferentes colunas para as seguintes comunidades:
...
- Deverão ser exibidos os últimos 6 posts da comunidade associada ao segmento utilizado
...
- Deverão ser exibidos 6 posts para as comunidades associadas ao módulo acessado. No caso de existir mais de uma comunidade pro mesmo módulo, deverão ser divididos os resultados exibidos entre as comunidades e o link Veja Mais deverá ser montado baseado na comunidade de maior relevância.
...
- Deverão ser exibidos 6 posts das comunidades de consultoria tributária seguindo a mesma regra das comunidades @módulo. Caso exista mais de uma comunidade, dividir os resultados e montar o link Veja Mais com a comunidade mais relevante.
...
As comunidades #Segmentos deverão ser consultadas conforme a lista abaixo:
Nome | Alias |
Manufatura | manufatura-community |
Construção e Projetos | construoeprojetos-community |
Educacional | educacional-community |
Financial | financial-community |
Jurídico | jurdico-community |
Saúde | sade-community |
Microempresas | microempresas |
Serviços | servios-community |
Distribuição e logística | distribuioelogstica-community |
Varejo | varejo-community |
...
| Nota | ||
|---|---|---|
| ||
Diferente das outras fontes (Blog, YouTube e TDN), o Fluig será a única fonte onde o conteúdo publicado na central será um conteúdo privado que necessita de autenticação (todas as outras fontes disponíveis na central de ajuda exibirão conteúdos públicos). |
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
http://fluig.totvs.com/api/public/social/post/listSortedPost/construoeprojetos-community?limit=6 |
...
A busca adicional não será aplicada ao Fluig.
...
A API do Fluig irá retornar um JSON semelhante ao exemplo abaixo.
|
| object |
| {2} | |
|---|---|---|---|---|---|
|
|
| content |
| [2] |
|
|
| 0 |
| {31} |
|
|
| postId | : | 2681855 |
|
|
| text | : | Olá,\nAlguém poderia por favor me explicar o recurso de Associação entre Serviços e Atividades?\nQue seria o objetivo e aplicações?\nObrigado.\n#TOP |
|
|
| formattedWithoutMention | : | Olá,\nAlguém poderia por favor me explicar o recurso de Associação entre Serviços e Atividades?\nQue seria o objetivo e aplicações?\nObrigado.\n#TOP |
|
|
| link | : |
|
|
|
| formattedLink | : |
|
|
|
| youtubeVideoId | : | null |
|
|
| user |
| {33} |
|
|
| social |
| {33} |
|
|
| creationDate | : | 1435278028000 |
|
|
| tenantId | : | 10097 |
|
|
| linkedObject | : | null |
|
|
| type | : | DEFAULT |
|
|
| visibility | : | PUBLIC |
|
|
| comments |
| [2] |
|
|
| numberLikes | : | 0 |
|
|
| numberShares | : | 0 |
|
|
| numberComments | : | 2 |
|
|
| numberDenouncements | : | 0 |
|
|
| numberWatchers | : | 2 |
|
|
| tags | : | null |
|
|
| url | : | /post/construoeprojetos-community/2681855 |
|
|
| recommendationMetadata |
| {0} |
|
|
| customData |
| {0} |
|
|
| hasMentions | : | false |
|
|
| mentions | : | null |
|
|
| originShare | : | null |
|
|
| supported | : | false |
|
|
| watching | : | false |
|
|
| shareMentionVO | : | null |
|
|
| formattedText | : | Olá,\nAlguém poderia por favor me explicar o recurso de Associação entre Serviços e Atividades?\nQue seria o objetivo e aplicações?\nObrigado.\n#TOP |
|
|
| youtubeLink | : | false |
...
|
|
| object |
| {2} |
|---|---|---|---|---|---|
|
|
| content |
| [10] |
|
|
| 0 |
| {31} |
|
|
| 1 |
| {31} |
|
|
| postId | : | 2631806 |
|
|
| text | : |
|
|
|
| formattedWithoutMention | : |
|
|
|
| link | : |
|
|
|
| formattedLink | : |
|
|
|
| youtubeVideoId | : | null |
|
|
| user |
| {33} |
|
|
| social |
| {33} |
|
|
| creationDate | : | 1432316497000 |
|
|
| tenantId | : | 10097 |
|
|
| linkedObject |
| {26} |
|
|
| id | : | 2631794 |
|
|
| tenantId | : | 10097 |
|
|
| creationDate | : | 1432316344000 |
|
|
| lastUpdateDate | : | 1432316344000 |
|
|
| user |
| {20} |
|
|
| social |
| {20} |
|
|
| numberLikes | : | 0 |
|
|
| numberShares | : | 6 |
|
|
| numberComments | : | 0 |
|
|
| numberDenouncements | : | 0 |
|
|
| numberWatchers | : | 2 |
|
|
| tags | : | null |
|
|
| url | : | /post/ana.pasini-69/2631794 |
|
|
| sociableType | : | SocialPost |
|
|
| removed | : | false |
|
|
| customData | : | {} |
|
|
| text | : | Boa tarde pessoal, estou com um problema na configuração dos cheques do Santander, já alterei de tudo... o primeiro formulário imprime certinho, mas o segundo imprime totalmente fora das linhas de impressão. as vezes altero a linha e a configuração muda a coluna !! \nAlguém tem por acaso os parâmetros do Santander pra me passar? Ou alguém pode me ajudar de alguma outra forma?\n#cheque #impressao #santander |
|
|
| link | : |
|
|
|
| type | : | DEFAULT |
|
|
| visibility | : | PUBLIC |
|
|
| linkedObject | : | null |
|
|
| hasMentions | : | false |
|
|
| youTubeLink | : | false |
|
|
| author |
| {20} |
|
|
| textWithMentions | : | Boa tarde pessoal, estou com um problema na configuração dos cheques do Santander, já alterei de tudo... o primeiro formulário imprime certinho, mas o segundo imprime totalmente fora das linhas de impressão. as vezes altero a linha e a configuração muda a coluna !! \nAlguém tem por acaso os parâmetros do Santander pra me passar? Ou alguém pode me ajudar de alguma outra forma?\n#cheque #impressao #santander |
|
|
| mentioningId | : | 2631794 |
|
|
| |||
|
|
| type | : | RECOMMENDATION |
|
|
| visibility | : | CUSTOM |
|
|
| comments |
| [0] |
|
|
| numberLikes | : | 0 |
|
|
| numberShares | : | 0 |
|
|
| numberComments | : | 0 |
|
|
| numberDenouncements | : | 0 |
|
|
| numberWatchers | : | 1 |
|
|
| tags | : | null |
|
|
| url | : | /post/financial-community/2631806 |
|
|
| |||
|
|
|
Atenção: os posts do fluig não possuem título. Por isso deverá ser usado o conteúdo do post. O conteúdo deverá ser cortado de forma que seja exibido duas linhas no link da Central de Ajuda concatenada com '...'
Exemplo:
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<a href="http://fluig.totvs.com/portal/p/10097/post/financial-community/2631806"> Boa tarde pessoal, estou com um problema na configuração dos cheques...</a> |
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<a href="http://fluig.totvs.com/portal/p/10097/subject/construoeprojetos-community">Veja Mais</a> |
...
Definição pendente de verificação das comunidades de MI
...
| Nota | ||
|---|---|---|
| ||
Não será suportado nenhum tipo de autenticação. |
A busca no Fluig será feita com base nas comunidades #Segmento.
Ao entrar na central de ajuda, deverá ser feita uma busca listando os últimos 10 posts da comunidade relacionada ao segmento, de acordo com a lista abaixo:
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:
...
{{versao}}
{{modulo}}
{{rotina}}
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
http://localhost:8044/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.
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
http://localhost:8044/rest/api/content/search?cql=SPACE=QUALQUER and label=segmento and label=versao [[and label=modulo]] [[and label=rotina]] and TEXT ~ texto &LIMIT=6 |
...
- Título da fonte de integração
Título exibido na central de ajuda
- URL base
Será a URL inicial utilizada na criação dos links exibidos na central de ajuda
- Campo URL
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 dois pontos entre cada campo.
- Campo Title
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 dois pontos entre cada campo.
- Limite caracteres Title
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"results": [
{
"id": "557074",
"type": "page",
"title": "Relatórios MATR263/MATR264/MATR266",
"_links": {
"webui": "/pages/viewpage.action?pageId=557074",
"tinyui": "/x/EoAI",
"self": "http://localhost:8044/rest/api/content/557074"
}, |
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<a href="http:localhost:8044/pages/viewpage.action?pageId=557074">Relatórios MATR263/MATR264/MATR266</a> |
...
- Configuração de acesso à API
- URL Busca Inicial
- URL Busca Avançada
- 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
- Limite caracteres Title
...
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
| Idioma | sigla |
|---|---|
| português | pt |
| inglês | en |
| espanhol | es |
...
| Status do documento | Concluído |
|---|---|
| Data | 23/08/2015 |
| Versão | 2.0 |
| Versão anterior | 1.0 |
| Autores |
...
&key=\{YOUR_API_KEY}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas