1) Sobre a Tela de Registros do Sankhya
A Tela de Registros do Sankhya é o painel de consulta onde você pode visualizar, investigar e auditar todos os eventos processados pela integração entre Ploomes e Sankhya.
Cada ação de importação (Sankhya → Ploomes) ou exportação (Ploomes → Sankhya) gera um registro que fica disponível nessa tela, com informações detalhadas sobre o que aconteceu, quando aconteceu e o resultado da operação.
Essa tela é útil para confirmar se um documento ou cadastro foi processado corretamente, identificar falhas na integração e entender o motivo de eventuais erros — tudo a partir de uma interface centralizada com filtros de busca.
A tela está disponível para usuários administradores e não administradores, com diferenças de visibilidade:
Administradores têm acesso completo aos registros de importação e exportação de todos os usuários da conta.
Não administradores visualizam apenas os registros de exportação gerados pelas suas próprias ações.
2) Pré-requisitos
Possuir a integração Sankhya V3 ativa na conta Ploomes.
Se a interface da tela de registros for igual à do GIF acima, implica que já está na CV3. Caso a interface esteja diferente, com abas para exportação e importação, a conta ainda estará utilizando a integração Sankhya V2.
3) Utilizando a Tela de Registros do Sankhya
3.1) Acessando a tela
O caminho de acesso varia de acordo com o perfil do usuário:
Para usuários administradores:
Acesse a Tela de Administração > Menu Integrações > clique no botão Registros do Sankhya.
Para usuários não administradores:
Clique no ícone do Sankhya localizado no menu superior direito do Ploomes. Esse ícone está disponível em todas as telas da plataforma.
Observação: usuários não administradores acessam a tela com um filtro fixo pelo usuário logado, exibindo apenas os registros de exportação gerados por eles mesmos.
3.2) Filtros de consulta
Ao acessar a tela, você pode utilizar filtros para localizar os registros desejados. Os filtros são divididos em obrigatórios e opcionais.
Filtros obrigatórios:
Filtro | Descrição |
Direção da ação | Define se você deseja consultar registros de importação (Sankhya → Ploomes) ou de exportação (Ploomes → Sankhya). |
Entidade Sankhya | Define qual tipo de entidade você deseja consultar. As opções são: |
Intervalo de datas | Define o período da consulta. Apenas registros dentro do intervalo selecionado serão exibidos. |
Filtros opcionais:
Filtro | Descrição |
Usuário Ploomes que gerou a ação | Permite filtrar registros por um usuário específico que originou a ação. |
Status da ação | Permite filtrar pelo resultado da operação: Ok (processada com sucesso) ou Falhou (ocorreu erro no processamento). |
ID do item no Ploomes | Permite buscar todos os registros vinculados a um item específico a partir do seu ID no Ploomes. |
ID do item no Sankhya | Permite buscar todos os registros vinculados a um item específico a partir do seu ID no Sankhya. |
Tipo de ação | Permite filtrar pelo tipo de operação realizada pela integração. |
Após definir os filtros desejados, a tabela será atualizada exibindo apenas os registros compatíveis com os critérios aplicados.
3.3) Consultando registros de importação
Para visualizar os registros de dados importados do Sankhya para o Ploomes, selecione Direção da ação = Sankhya → Ploomes nos filtros de consulta.
Em seguida, defina a Entidade Sankhya e o Intervalo de datas desejados, e utilize os filtros opcionais caso precise refinar a busca.
A tabela exibirá todos os registros de importação que atendem aos critérios selecionados.
3.4) Consultando registros de exportação
Para visualizar os registros de dados exportados do Ploomes para o Sankhya, selecione Direção da ação = Ploomes → Sankhya nos filtros de consulta.
Em seguida, defina a Entidade Sankhya e o Intervalo de datas desejados, e utilize os filtros opcionais caso precise refinar a busca.
A tabela exibirá todos os registros de exportação que atendem aos critérios selecionados.
3.5) Consultando o histórico de um item específico
Se você precisa investigar tudo o que aconteceu com um item específico na integração, pode buscá-lo diretamente pelo seu ID — seja o ID do Ploomes ou o ID do Sankhya.
Buscando pelo ID do Ploomes:
No campo de filtro ID do item no Ploomes, informe o ID do item desejado.
Defina a Entidade Sankhya e o Intervalo de datas.
A tabela exibirá todos os registros (importação e exportação) vinculados a esse item.
Buscando pelo ID do Sankhya:
No campo de filtro ID do item no Sankhya, informe o ID do item desejado.
Defina a Entidade Sankhya e o Intervalo de datas.
A tabela exibirá todos os registros (importação e exportação) vinculados a esse item.
Dica: essa consulta é especialmente útil para auditar o histórico completo de um cadastro ou documento e entender todas as ações que a integração executou para aquele item.
3.6) Visualizando os detalhes de um registro
Para acessar as informações completas de um registro, clique sobre a linha desejada na tabela. Um painel de detalhes será aberto na lateral da tela com todas as informações técnicas do evento.
Abaixo estão listado os campos disponíveis no painel de detalhes:
Informações do registro:
Campo | Descrição |
Data da ação | Data e hora em que a ação foi processada pela integração. |
ID da ação | Identificador único do registro da ação. |
Data de criação na fila | Data e hora em que o evento entrou na fila de processamento da integração. |
ID da integração | Identificador da integração na conta. |
Direção da ação | Indica se o registro é de importação (Sankhya → Ploomes) ou exportação (Ploomes → Sankhya). |
ID do item no Ploomes | ID do cadastro ou documento no Ploomes. |
ID do item no Sankhya | ID do cadastro ou documento no Sankhya. |
Entidade Ploomes | Tipo de entidade correspondente no Ploomes. |
Entidade Sankhya | Tipo de entidade correspondente no Sankhya. |
Status da ação | Resultado da operação: Ok ou Falhou. |
Tipo de ação | Tipo de operação realizada pela integração. |
Motivo da falha | Descrição resumida do erro, caso a ação tenha falhado. |
Detalhamento da falha | Informações adicionais sobre o erro ocorrido. |
Quantidade de retries | Número de tentativas realizadas pela integração para processar a ação. |
Usuário Ploomes que gerou a ação | Usuário do Ploomes responsável pela ação que originou o evento. |
Payloads:
O painel também exibe os payloads do evento em formato JSON:
Payload | Descrição |
Dados da ação | Informações gerais da ação processada. |
Payload de requisição | Dados enviados pela integração ao sistema de destino. |
Payload de resposta | Dados retornados pelo sistema de destino após o processamento. |
Dica 1: os campos do painel de detalhes possuem a opção de copiar o conteúdo, facilitando o compartilhamento de informações para análise ou suporte.
Dica 2: Para copiar os payloads, passe o cursor do mouse sobre a célula com o conteúdo e clique no ícone de copiar.
Dica 3: para formatar os payloads com indentação clique no botão "Alternar formatação".
4) Limitações
Consulta somente leitura: não é possível editar, excluir ou reprocessar registros diretamente pela tela. A consulta é exclusivamente para visualização.
Visibilidade limitada para não administradores: usuários não administradores visualizam apenas os registros de exportação gerados por suas próprias ações.
5) F.A.Q.
Por que não consigo ver registros de importação?
Se você é um usuário não administrador, a tela exibe apenas os registros de exportação gerados pelas suas próprias ações. Para ter acesso aos registros de importação e aos dados de todos os usuários, é necessário ter perfil de administrador.
Os logs dos eventos somem após a edição da integração?
Não. A partir da V3 da integração Sankhya, com a nova interface da tela de logs os registros não somem após uma edição da integração.
Posso editar ou excluir registros pela tela?
Não. A Tela de Registros do Sankhya é exclusivamente de consulta. Não é possível alterar, excluir ou reprocessar registros por ela.
Como encontro o registro de um item específico?
Utilize os filtros ID do item no Ploomes ou ID do item no Sankhya para buscar diretamente pelo identificador do cadastro ou documento desejado. A tabela exibirá todos os registros de importação e exportação vinculados a esse item e a Entidade Sankhya filtrada.
O que significa o Status da ação "Ok"?
Significa que a operação foi processada com sucesso pela integração — o dado foi importado ou exportado sem erros.
O que significa o Status da ação "Falhou"?
Significa que ocorreu um erro durante o processamento da ação. Para entender o motivo, clique sobre o registro e consulte os campos Motivo da falha e Detalhamento da falha no painel de detalhes.
A tela mostra registros em tempo real?
A tela exibe os registros disponíveis no momento da consulta. Para visualizar novos registros, aplique os filtros desejados novamente ou atualize a página.
6) Glossário
Importação: processo no qual dados são trazidos do Sankhya para o Ploomes pela integração.
Exportação: processo no qual dados são enviados do Ploomes para o Sankhya pela integração.
Direção da ação: indica o sentido do fluxo de dados do registro — se é uma importação (Sankhya → Ploomes) ou uma exportação (Ploomes → Sankhya).
Entidade Sankhya: tipo de cadastro ou documento no Sankhya ao qual o registro se refere (ex:
Parceiro cliente pessoa jurídica,Orçamento,Pedido de Venda, etc.).Entidade Ploomes: tipo de cadastro ou documento no Ploomes ao qual o registro se refere.
Payload: conjunto de dados técnicos transmitidos ou recebidos pela integração durante o processamento de uma ação. Exibido em formato JSON.
Status da ação: resultado do processamento do registro pela integração — Ok (sucesso) ou Falhou (erro).
Tipo de ação: classificação da operação realizada pela integração (ex: criação, edição, deleção).
Retry: tentativa automática de reprocessamento que a integração realiza quando uma ação falha.
JSON: formato de texto estruturado utilizado para representar dados de forma organizada em pares de chave e valor.