Índice:

Introdução:

     O que é o RM.Host.Cleanner?

        O RM.Host.Cleanner tem a finalidade de limpar arquivos e dados temporários da base de dados, diminuindo a utilização de espaço em disco e melhorando a performance de uma forma geral. 

         Ele é completamente parametrizável, incluindo as operações que irá executar e o intervalo de execução das mesmas. O Cleanner é seletivo quanto aos itens a serem removidos e apaga apenas itens que já existam há um determinado tempo, tempo este que é também parametrizável.

Como instalar: 

       O RM.Host.Cleanner é um serviço do Windows. Para instalá-lo é necessário criar o arquivo RM.Host.Cleanner.exe.config na pasta RM.net.

<?xml version="1.0"?>
<configuration>
  <appSettings>
    <add key="CleaningInterval" value="1"/>
    <add key="PathToClean" value="C:\totvs\CorporeRM"/>
    <add key="RemoveFoldersOlderThan" value="1"/>
    <add key="RemoveJobsOlderThan" value="1"/>
    <add key="DBServer" value="sterm-pt01/SCOPA"/>
    <add key="DBName" value=""/>
    <add key="DBUser" value="rm"/>
    <add key="DBPassword" value="rm"/>
	<add key="RemoveSnowdenLogsOlderThan" value="20"/>
    <add key="UseDevartDirect" value="false" />
  </appSettings>
<startup><supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/></startup></configuration>

<?xml version="1.0"?>
<configuration>
  <appSettings>
    <add key="CleaningInterval" value="1"/>
    <add key="PathToClean" value="C:\totvs\CorporeRM"/>
    <add key="RemoveFoldersOlderThan" value="1"/>
    <add key="RemoveJobsOlderThan" value="1"/>
    <add key="DBServer" value="T000000339"/>
    <add key="DBName" value="EXEMPLO1181"/>
    <add key="DBUser" value="rm"/>
    <add key="DBPassword" value="rm"/>
	<add key="RemoveSnowdenLogsOlderThan" value="20"/>
  </appSettings>
<startup><supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/></startup></configuration>

       Após criar o arquivo .config, desinstalar o host e deletar o broker, basta acessar o diretório C:\totvs\CorporeRM\RM.Net e executar o arquivo em lotes "Instalar RM.Host.Cleanner.bat". Este arquivo .bat já instala a aplicação como um serviço e, logo após a sua execução, já será possível visualizar o mesmo na janela de “Serviços” do Windows (digite “services.msc” na janela “Executar” do Windows).

       O Cleanner deverá existir em cada máquina onde houver necessidade de fazer essa limpeza, e é útil principalmente em servidores de Terminal (Terminal Services).

       Recomendamos que o RM.Host.Cleanner seja instalado somente nos servidores (APP e TS) uma vez que as estações client, não geram grandes volumes de arquivos temporários.

       Outra forma de ativar o RM.Host.Cleanner é através da instalação da Biblioteca RM, na qual é possível realizar a parametrização.

 Passo a passo para realizar a parametrização:

 

Principais tabelas:  

• CAGLOTE: Agendamento de integração de lotes
• GJOBX: Armazena os Jobs
• GJOBLOG: Processos executados
• GJOBXCHANGELOG: Log de alterações do processo. (Versão 12.1.24 ou superior)
• GJOBXLOG: Armazena o log de execução dos jobs
• GJOBXEXECUCAO: Execução de Jobs
• GJOBXEXECUCAOHST: Histórico de execução dos jobs (A partir da versão 12.1.31 - Veja em: Melhorias no funcionamento do Job)
• QCUBODATA: Armazena os dados dos cubos e histórico de execução
• GRELBATCH: Armazena os relatórios que foram gerados via job
• GJOBQUEUE: Processos na fila para serem executados
• GCRITICALLOG: Tabela responsável por armazenar os logs críticos.
• GSNOWDENCACHE: Tabela de cahce das consultas do Snowden

Regra para limpeza de arquivos e diretórios: 

       O RM.Host.Cleanner segue a seguinte regra para limpeza de arquivos e diretórios:

• No diretório temporário do usuário (C:\Users\UserName\AppData\Local\Temp) serão removidos:
  1. Todos os arquivos com a extensão *.tmp e *.ResourceStrings.

• No diretório definido pela tag <add key="PathToClean"> (caso não esteja configurado, será considerado o diretório onde se encontra o RM.Host.Cleanner) serão removidos:

  1. Todos os sub-diretórios que comecem com _RM e terminem com .TMP (_RM*.TMP), bem como seus respectivos arquivos.

  2. Todos os sub-diretórios dentro de "PathToClean"\RM.Net\Processos\Logs\, bem como seus respectivos arquivos.

  3. Todos os sub-diretórios dentro de "PathToClean"\Processos\Logs\, bem como seus respectivos arquivos.

Exemplo: 

No diretório C:\TOTVS\CorporeRM\RM.Net\Processos\Logs existem pastas e arquivos:

Quando realizada a execução do RM.Host.Cleanner, perceba que as pastas foram apagadas, mas os arquivos soltos permaneceram no diretório.

• No diretório definido pela tag <add key="LogPath"> do arquivo RM.Host.Service.exe.config, serão removidos:

  • Todos os sub-diretórios, bem como seus respectivos arquivos.

Observações: 

       Segue o critério do serviço para determinar o que deve ou não ser removido da base:

• Jobs que já foram executados (DATAFIMEXEC não nula), com sucesso ou não, anteriormente à data calculada de acordo com a parametrização RemoveJobsOlderThan serão apagados. Ou seja, todos os jobs executados com status diferente de 0 ou 1, serão apagados. 
• Jobs com status 3 ou 7 serão deletados independente de terem iniciado a execução. Obs: A partir das versões 12.1.33.266, 12.1.34.166, 12.1.2205.108 apenas os jobs que tenham a data de última alteração anterior à data calculada de acordo com a parametrização RemoveJobsOlderThan serão apagados.

• Jobs recorrentes terão somente as suas execuções já finalizadas e de acordo com os critérios acima apagadas. O registro do Job (GJOBX) será mantido para as futuras execuções recorrentes. 

       Abaixo segue uma lista com todos os status possíveis dos jobs e seus significados:

• None = 0 - O Job ainda não foi executado
• Running = 1 - O Job está em execução
• Finished = 2 - O Job terminou normalmente a sua execução
• Canceled = 3 - A execução do Job foi cancelada
• Stopped = 4 - A execução do Job começou e foi interrompida
• Error = 5 - Erro na execução do job
• Warning = 6 - O Job foi executado com avisos
• Failed = 7 - Houve uma falha no servidor durante a execução do Job e a mesma não terminou corretamente.
• Disabled = 8 - A execução do job está suspensa até ele ser habilitado novamente. Se ele for habilitado antes da sua hora programada ele roda normalmente, se for depois da sua hora programada e ele tiver recorrência, sua recorrência é recalculada e ele é atualizado para aquela data/hora recalculada; se ele não tiver recorrência, seu status vira Canceled.
• NoJobServerAvailable = 9 - No momento da execução do Job, um servidor capaz de processar o Job não estava ativo.

Recomendação sobre a base da dados: 

       Por segurança, recomendamos a criação de um usuário de banco específico para o uso do RM.Host.Cleanner.  

       Após criar o usuário, será necessário liberar o grant para as tabelas abaixo:

• GJOBX 
• GJOBXEXECUCAO
• GJOBXEXECUCAOHST (A partir da versão 12.1.31 - Veja em: Melhorias no funcionamento do Job)
• GJOBXCHANGELOG 
• GJOBXLOG 
• GJOBLOG 
• GRELBATCH 
• GJOBQUEUE 
• CAGLOTE 
• QCUBODATA 
• GUSUARIO 
• GSNOWDENCACHE
• GCRITICALLOG

Como desinstalar: 

       Para desinstalar o serviço basta rodar o arquivo em lotes "Desinstalar RM.Host.Cleanner.bat", disponível no diretório: C:\totvs\CorporeRM\RM.Net