Histórico da Página

Objetivo

O objetivo é disponibilizar uma área de configuração dos parâmetros utilizados pela documentação de customização, permitindo a busca em fontes de pesquisa do próprio cliente.

Para mais informações acessar Documentação de Customização.

Visão Geral

Quando marcada a opção Habilitar funcionalidade como preencha as demais informações, considerando que apenas os parâmetros initialurl, titlefield e urlfield são obrigatórios.

Parâmetros Documentação de Customização

As configurações seguem a especificação Parâmetros para acionar a Central de Ajuda, abaixo temos uma tabela com os parâmetros utilizados no produto DATASUL

Informações
A opção Habilitar funcionalidade é exclusiva no produto DATASUL, utilizada para ativar e desativar o envio de parâmetros para central de ajuda TOTVS, não faz parte da especificação Parâmetros para acionar a Central de Ajuda

Exemplo 1

Resultado da busca inicial (Parâmetro initialurl) por módulo e programa:

Expandir

title	Clique aqui para expandir

Bloco de código

theme	RDark
title	Exemplo 1 - Configuração

Parâmetro initialurl: http://<SERVIDOR>:<PORTA>/exemplo1?codModule={{codModule}}[[&action={{action}}]] 
Parâmetro seemoreurl: http://<link 'veja mais'> 
Parâmetro titlefield: html_url 
Parâmetro titlefield: title 
Parâmetro pagetitle:  EXEMPLO 1 - DOCUMENTOS CUSTOMIZADOS

http://<SERVIDOR>:<PORTA>/exemplo1?codModule={{codModule}}[[&action={{action}}]]

Bloco de código

theme	RDark

[ 
	{ 
	  "html_url": "http://<link do documento do programa>", 
	  "title": "Exemplo de documento customizado programa - SEC - SEC000AA" 
	} 
]

Abaixo podemos verificar na imagem a área para documentos customizados, está localizada abaixo das áreas de conteúdos TOTVS.

Resultado da busca inicial (Parâmetro initialurl) por módulo:

Expandir

title	Clique aqui para expandir

http://<SERVIDOR>:<PORTA>/exemplo1?codModule={{codModule}}[[&action={{action}}]]
- O valor em colchetes [[]] será removido ao realizar a busca por modulo, no exemplo configurado
  - http://<SERVIDOR>:<PORTA>/exemplo1?codModule={{codModule}}

Bloco de código

theme	RDark

[ 
	{ 
		"html_url": "http://<link do documento do programa>", 
		"title": "SEC - Exemplo 1 de documento customizado programa" 
	}, 
	{ 
		"html_url": "http://<link do documento do programa>", 
		"title": "SEC - Exemplo 2 de documento customizado programa" 
	}, 
	{ 
		"html_url": "http://<link do documento do programa>", 
		"title": "SEC - Exemplo 3 de documento customizado programa" 
	} 
]

Abaixo podemos verificar na imagem a área para documentos customizados, está localizada abaixo das áreas de conteúdos TOTVS.

Ilustração do exemplo 1, mostrando onde os parâmetros são utilizados:

Expandir

title	Clique aqui para visualizar

Exemplo 2

A configuração do exemplo 2 faz o uso dos parâmetros arrayname e baseurl.

Resultado da busca inicial (Parâmetro initialurl) por módulo e programa:

Expandir

title	Clique aqui para expandir

Bloco de código

theme	RDark
title	Exemplo 2 - Configuração

Parâmetro initialurl: http://<SERVIDOR>:<PORTA>/exemplo2?codModule={{codModule}}[[&action={{action}}]] 
Parâmetro seemoreurl: http://<link 'veja mais'> 
Parâmetro arrayname:  urls 
Parâmetro urlfield:   html_url 
Parâmetro titlefield: title 
Parâmetro baseurl:    http://<prefixo da URL> 
Parâmetro pagetitle:  EXEMPLO 2 - DOCUMENTOS CUSTOMIZADOS

http://<SERVIDOR>:<PORTA>/exemplo2?codModule={{codModule}}[[&action={{action}}]]
- Observar que neste exemplo a propriedade urls contem a lista dos documentos, o nome dessa propriedade de retorno deve possuir o nome igual ao Parâmetro arrayname

Bloco de código

theme	RDark

{ 
	"urls": [ 
				{ 
					"html_url": "/<PATH DO DOCUMENTO>", 
					"title": "Exemplo de documento customizado programa - SEC - SEC000AA" 
				} 
			] 
}

O valor da propriedade html_url será concatenada com o valor do Parâmetro baseurl
- http://<prefixo da URL>/<PATH DO DOCUMENTO>
Abaixo podemos verificar na imagem a área para documentos customizados, está localizada abaixo das áreas de conteúdos TOTVS.

Resultado da busca inicial (Parâmetro initialurl) por módulo:

Expandir

title	Clique aqui para expandir

http://<SERVIDOR>:<PORTA>/exemplo2?codModule={{codModule}}[[&action={{action}}]]
- O valor em colchetes [[]] será removido ao realizar a busca por modulo, no exemplo configurado
  - http://<SERVIDOR>:<PORTA>/exemplo1?codModule={{codModule}}
- Observar que neste exemplo a propriedade urls contem a lista dos documentos, o nome dessa propriedade de retorno deve possuir o nome igual ao Parâmetro arrayname

Bloco de código

theme	RDark

{ 
	"urls": [ 
				{ 
					"html_url": "/<PATH DO DOCUMENTO>", 
					"title": "SEC - Exemplo 1 de documento customizado programa" 
				}, 
				{ 
					"html_url": "/<PATH DO DOCUMENTO>", 
					"title": "SEC - Exemplo 2 de documento customizado programa" 
				}, 
				{ 
					"html_url": "/<PATH DO DOCUMENTO>", 
					"title": "SEC - Exemplo 3 de documento customizado programa" 
				} 
			] 
}

O valor da propriedade html_url será concatenada com o valor do Parâmetro baseurl
- http://<prefixo da URL>/<PATH DO DOCUMENTO>
Abaixo podemos verificar na imagem a área para documentos customizados, está localizada abaixo das áreas de conteúdos TOTVS.

Ilustração do exemplo 2, mostrando onde os parâmetros são utilizados:

Expandir

title	Clique aqui para visualizar

Informações
Os exemplos 1 e 2 estão utilizando parâmetros na URL de busca inicial (`Parâmetro initialurl`) , para mais informações sobre os parâmetros que podem ser utilizados, verificar a página Parâmetros para o cliente configurar a customização

Árvore de páginas

Versões comparadas

Versão antiga 26

Nova versão Atual

Chave

Parâmetros Documentação de Customização