TOTVSTEC

Árvore de páginas

Define as funções ADVPL/TLPP a serem executadas para determinados eventos com a thread e atendimento.

ChaveTipoObrigatório
OnBlockString--
OnAllowString--
OnStartString--
OnStopString--
OnErrorString--
OnSelectString--
OnSendString--


A obrigatoriedade funciona de maneira diferente da convencional, pois não é obrigado informar qualquer uma das chaves acima, porém, quando a chave é criada na configuração temos a obrigação de informar o nome da função que fará atendimento da callback.

Chaves da sessão


OnBlock

Função que será executada na inicialização do serviço REST para informar uma lista de URNs que serão bloqueadas para esse ambiente.


OnAllow

Função que será executada na inicialização do serviço REST para informar uma lista de URNs que serão permitidas para esse ambiente, portanto as demais serão automaticamente bloqueadas.

OnStart

Função que será executada na inicialização da thread de atendimento REST.

OnStop

Função que será executada na finalização da thread de atendimento REST.

OnError

Função que será executada caso ocorra algum erro na thread. Pode ser utilizada para tratar error.log, pois recebe o objeto error como parâmetro permitindo customizar a saída desta informação.

OnSelect

Função que poderá ser executada para para selecionar quem atenderá a requisição.

OnSend

Função que será executada ou pouco antes do envio final da mensagem de resposta de uma requisição REST.


Mais detalhes sobre User Exits, consulte aqui

Exemplos de configuração

Arquivo appserver.ini

[UE_01]
OnBlock=ON_BLOCK_01
OnAllow=ON_ALLOW_01
OnStart=ON_START_01
OnStop=ON_STOP_01
OnError=ON_ERROR_01
OnSelect=ON_SELECT_01
OnSend=ON_SEND_01

[UE_02]
OnBlock=ON_BLOCK_02
OnAllow=ON_ALLOW_02
OnStart=ON_START_02
OnStop=ON_STOP_02
OnError=ON_ERROR_02
OnSelect=ON_SELECT_02
OnSend=ON_SEND_02


JSON

jConfig['UE_01'] := JsonObject():new()
jConfig['UE_01']['OnBlock'] := ON_BLOCK_01
jConfig['UE_01']['OnAllow'] := ON_ALLOW_01
jConfig['UE_01']['OnStart'] := ON_START_01
jConfig['UE_01']['OnStop'] := ON_STOP_01
jConfig['UE_01']['OnError'] := ON_ERROR_01
jConfig['UE_01']['OnSelect'] := ON_SELECT_01
jConfig['UE_01']['OnSend'] := ON_SEND_01

jConfig['UE_02'] := JsonObject():new()
jConfig['UE_01']['OnBlock'] := ON_BLOCK_02
jConfig['UE_01']['OnAllow'] := ON_ALLOW_02
jConfig['UE_02']['OnStart'] := ON_START_02
jConfig['UE_02']['OnStop'] := ON_STOP_02
jConfig['UE_02']['OnError'] := ON_ERROR_02
jConfig['UE_02']['OnSelect'] := ON_SELECT_02
jConfig['UE_01']['OnSend'] := ON_SEND_02
  • Sem rótulos