Tela Log de Alterações para API

Neste artigo

• O que é e para que serve
• Antes de começar
• Como usar a tela
• Grade de instâncias monitoradas
• Como consultar os registros gerados
• Pontos de atenção
• Perguntas frequentes

Módulo: Configurações › Rotinas
Caminho de acesso: Menu Principal › Configurações › Rotinas › Log de Alterações para API

O que é e para que serve

A tela Log de Alterações para API permite ativar o registro automático de alterações realizadas nas tabelas do Sankhya Om, tornando essas alterações consultáveis por integrações externas via API. Use essa tela quando você precisa que um sistema integrado ao Sankhya Om detecte e processe mudanças nos dados — por exemplo, sincronizar cadastros alterados com outro sistema ou rastrear modificações para fins de auditoria via API. Ela não controla permissões de acesso à API, não exibe o histórico de alterações diretamente na interface e não substitui os recursos de auditoria internos do Sankhya Om.

A partir da versão 4.35b30, essa funcionalidade passou a operar de forma independente do Sankhya Om principal, o que reduz o impacto nas atualizações do sistema e melhora a escalabilidade do registro.

Antes de começar

• Você precisa ter permissão de administrador para acessar rotinas em Configurações.
• Após qualquer alteração no status do serviço (habilitar ou desabilitar), é obrigatório reiniciar o Sankhya Om para que as mudanças entrem em vigor.

Como usar a tela

A tela tem dois estados: serviço desabilitado e serviço habilitado. O conteúdo principal — a grade de instâncias — só aparece após você habilitar o serviço pelo switch no canto superior direito.

Para habilitar o serviço:

1. Acesse Configurações › Rotinas › Log de Alterações para API.
2. Clique no switch Log de Alterações no canto superior direito. O status muda para Habilitado.

1. Reinicie o Sankhya Om para que o registro de alterações comece a funcionar.

Grade de instâncias monitoradas

Após habilitar o serviço, a grade exibe todas as entidades disponíveis para monitoramento. Cada linha representa uma entidade do sistema com sua tabela correspondente.

Colunas da grade

• Instância — nome da entidade do sistema configurada para monitoramento.
• Tabela — identificador técnico da tabela no banco de dados correspondente à instância (por exemplo, TSIAGE, TGFCAB).
• Status configurado — intenção de monitoramento definida por você: Habilitado ou Desabilitado. Reflete o que foi configurado, não necessariamente o que está ativo no momento.
• Trigger — indica se o mecanismo de captura de alterações foi criado no banco de dados para aquela tabela. Quando vazio, ainda não foi aplicado — normalmente aguarda o reinício do sistema.
• Situação — estado real do monitoramento naquele momento. Pode ser diferente do Status configurado enquanto o sistema ainda não reiniciou ou processou a configuração.
• Campos monitorados — indica se o monitoramento de campos específicos está ativo para aquela entidade. Por padrão, aparece como Desabilitado.

Como habilitar ou desabilitar instâncias individualmente

Além do switch geral, você pode controlar o monitoramento por entidade:

1. Selecione uma ou mais linhas na grade.
2. Clique em Habilitar instância(s) ou Desabilitar instância(s) conforme desejado.

Isso permite ativar o log apenas para as entidades relevantes para a sua integração — por exemplo, somente Parceiro e Produto — sem monitorar todas as outras entidades da lista.

Como consultar os registros gerados

Após ativar o serviço e reiniciar o Sankhya Om, as alterações registradas ficam disponíveis de duas formas:

Pelo banco de dados

Os registros são gravados na tabela TGLATS com as seguintes informações: qual entidade foi alterada, quando a alteração ocorreu, a chave primária do registro alterado e o tipo de evento (inclusão, alteração ou exclusão).

Pela API

Consulte as alterações pelo endpoint https://api.sankhya.com.br/logAlteracoesTabelas. A requisição deve obrigatoriamente ser feita pelo Gateway Sankhya com um token de acesso válido. Tentativas sem autenticação retornarão erro.

Pontos de atenção

Diferença entre Status configurado e Situação

As duas colunas podem mostrar valores diferentes logo após uma alteração. O Status configurado reflete a sua intenção; a Situação reflete o estado real no banco de dados. Elas se alinham após o reinício do Sankhya Om.

Processamento assíncrono e atraso nos registros

O serviço registra alterações de forma assíncrona: um job automático executa a cada minuto para coletar as mudanças. Por isso, pode haver um atraso de até 1 minuto entre a alteração no sistema e sua disponibilização na API.

Período de retenção dos registros

O prazo padrão de retenção é de 3 dias. Para ambientes que precisam de um histórico mais longo, ajuste o parâmetro LOGTABMAXAGE em Configurações › Parâmetros do sistema. Períodos maiores aumentam o tamanho da tabela TGLATS — monitore o volume antes de alterar.

Ajuste de desempenho em bases com alto volume

Se a sua base tiver um volume muito alto de alterações, é possível ajustar o intervalo entre execuções do job, o volume processado por ciclo e o tamanho dos lotes de gravação. Esses ajustes devem ser feitos com acompanhamento técnico especializado, pois afetam diretamente o desempenho do banco de dados.

Compatibilidade com versões anteriores

O módulo de log é instalado mesmo em bases que ainda não usam a versão mais recente, garantindo compatibilidade e permitindo downgrade se necessário. O sistema identifica automaticamente qual versão está em uso.

Perguntas frequentes

Habilitei o serviço, mas as alterações não aparecem na API. O que verificar?

O motivo mais comum é a falta de reinicialização do Sankhya Om após habilitar o serviço. Reinicie o sistema e aguarde até 1 minuto para que o primeiro ciclo de coleta execute. Se receber a mensagem "Necessário habilitar o parâmetro LOGTABOPER", confirme também se o switch da tela está ativado.

O log registra quais campos foram alterados?

Não. O log registra que um determinado registro foi alterado, quando ocorreu e o tipo de evento (inclusão, alteração ou exclusão). Para identificar quais campos mudaram, consulte o histórico no sistema ou use a API com filtro modifiedSince.

O que acontece com os registros existentes se eu desabilitar o serviço?

Ao desabilitar, o sistema para de registrar novas alterações imediatamente. Os registros já gravados na tabela TGLATS são mantidos até serem removidos pelo job de limpeza automática (padrão: 3 dias), ou pelo prazo configurado em LOGTABMAXAGE.

Preciso habilitar todas as instâncias da grade?

Não. Selecione apenas as entidades relevantes para a sua integração e use Habilitar instância(s) somente para elas. Monitorar instâncias desnecessárias aumenta o volume de registros e pode impactar o desempenho.