Atenção
Na P12 a Central de Ajuda está disponível na versão da lib maior ou igual 20151013
Na P11 a Central de Ajuda está disponível na versão de lib maior ou igual a 20151216.1
Para uso da central de ajuda é obrigatório a configuração do License Server.
Conceito
A Central de Ajuda executa uma página HTML que é chamada pelo smartclient na abertura do help do produto.
Para isso são necessários extrair alguns arquivos de configuração (html, css e js) do RPO para um diretório pré-configurado em um servidor HTTP.
A extração doos arquivos do RPO para o diretório do servidor HTTP pode ocorrer de forma automática ou manual, dependendo das configurações do ambiente.
Em ambientes com load balance, a extração dos arquivos da Central de Ajuda deve ser feita obrigatoriamente de forma manual, conforme descritas no item "Extração de Arquivos".
Habilitar servidor HTTP
No appserver.ini habilite a seção HTTP com as chaves conforme exemplo:
[HTTP]
PORT=8079
ENABLE=1
PATH=C:\TOTVS\
Environment=Environment
Para detalhes do preenchimento de cada chave da sessão HTTP verifique o documento Seção HTTP -- 29360
Atenção - Ambientes com Load Balance
Em ambientes com load balance configurado, habilite o servidor HTTP apenas em um único appserver.ini (que pode ser no master ou em qualquer slave) e siga os procedimentos descritos no item "Extração de Arquivos"
Configurar chave HELPSERVER no environment
Na sessão do environment, configure a chave HELPSERVER com o endereço e porta do servidor HTTP configurado anteriormente.
Exemplo:
[Environment]
HELPSERVER=localhost:8079
Com essas configurações habilitadas, ao pressionar F1 no Protheus, o sistema irá carregar a página inicial da Central de Ajuda no endereço configurado em HELPSERVER.
Atenção - Ambientes com Load Balance
Em ambientes com load balance, essa chave deve estar configurada no appserver.ini de todos os slaves
Extração de Arquivos
A Central de Ajuda necessita que arquivos de configuração sejam extraídos do RPO para a pasta configurada do servidor HTTP.
Atenção
Esses arquivos são apenas de configuração para funcionamento da central. Todo conteúdo exibido é buscado de forma dinâmica no momento da abertura da Central.
Essa extração ocorre de forma automática quando o appserver do ambiente que está executando a chamada à Central de Ajuda é o mesmo que possui as configurações de servidor HTTP.
Ou seja, em ambientes com load balance configurado não é possível fazer a extração de forma automática.
Neste caso, deve-se fazer a extração manual seguindo os procedimentos abaixo:
- Abrir o SIGACFG na rotina Ambiente -> Help -> Config Central de Ajuda
- Selecionar a pasta para extração dos arquivos de configuração e clicar em extrair arquivos
Obs: Extraia os arquivos para a pasta que esta configurada o servidor HTTP, ou mova-os para esta pasta após a extração.
Caso haja alguma alteração na lib que impacte na Central de Ajuda, será necessário realizar esse procedimento para atualização da Central em ambientes onde não é possível fazer a atualização automática.
Em ambientes onde a atualização é feita automática, os arquivos de configuração da Central de Ajuda serão sobreescritos quando a versão contida no RPO for maior que a versão que estiver na pasta extraída.
Para maiores detalhes do funcionamento da Central verifique o documento Manual de utilização - Central de Ajuda