TOTVS Logística Recintos Aduaneiros

Árvore de páginas

Versões comparadas

Versão antiga 21

changes.mady.by.user Rodrigo Azanha

Gravado em

comparado com

Nova versão 22

changes.mady.by.user Rodrigo Azanha

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Totvs custom tabs box
tabsInstalação e Configuração, Eventos (Mensagens)
idsinstalacao,eventos
Totvs custom tabs box items
defaultyes
referenciainstalacao

Guia para a instalação e configuração da integração do sistema SARA com o PUCOMEX - Módulo Recintos.

NOTA: Para instalação e configuração da integração com o Módulo Recintos, é requisito possuir a instalação do EAIService do sistema SARA. Para sua instalação consulte a documentação EAI Service | Serviço de Integração.

Componentes

ComponenteDescrição
PuSiscomexRequest.bpl

Responsável pela autenticação, envio e recebimento de mensagens para o PUCOMEX | Módulo Recintos.

MRCredenciamentoPessoa.bpl

Responsável por buscar as informações referente ao credenciamento de pessoas e gerar a mensagem JSON para envio ao PUCOMEX.

MRAcessoPessoa.bplResponsável por buscar as informações referente ao acesso de pessoas (entrada e saída) e gerar a mensagem JSON para envio ao PUCOMEX.
MRCredenciamentoVeiculo.bplResponsável por buscar as informações referente ao credenciamento de veículos e gerar a mensagem JSON para envio ao PUCOMEX.
MRAcessoVeiculo.bplResponsável por buscar as informações referente ao acesso de veículos (Entrada e Saída) e gerar a mensagem JSON para envio ao PUCOMEX.

MRAgendamentoVeiculo.bpl

Responsável por buscar as informações referente ao agendamento de veículos e gerar a mensagem JSON para envio ao PUCOMEX.
PuSiscomex.iniArquivo de configuração para a autenticação com o PUCOMEX contendo o perfil do interveniente e o caminho das chaves do certificado digital para autenticação por E-CPF ou E-CNPJ.

Instalação dos componentes

Para a instalação dos componentes basta efetuar a cópia dos arquivos mencionados acima para a pasta de instalação do serviço do EAIService.


Instalação do Open SSL

A autenticação com os serviços do sistema PUCOMEX é realizada de forma segura por autenticação SSL, portanto para que isso ocorra deverá ser instalado o pacote de drivers do OpenSSL.

Para a instalação deverá ser executado o arquivo "Win32Install_OpenSSL_Silent_Mode.bat"  como administrador no servidor onde foi instalado o serviço EAIService. Este arquivo estará localizado na pasta EXECUTAVEIS do sistema SARA juntamente com o arquivo Win32OpenSSL-1_0_2q.exe.

Configuração do arquivo .INI 

O arquivo PuSiscomex.INI deverá ser criado na pasta CONFIG, localizado no diretório SERVICES/Config.

Neste arquivo deverá ser configurado o perfil do interveniente e o caminho das chaves da certificação digital A1 (e-CPF ou e-CNPJ) para autenticação no PUCOMEX.

Ver a lista de perfis de intervenientes disponíveis em https://docs.portalunico.siscomex.gov.br/.

As chaves do certificado digital A1 deverão estar em arquivos no formato .PEM. Para a geração dos arquivos seguir as orientações em "Geração dos arquivos .PEM de um certificado digital".


NOTA: Atualmente a certificação digital está disponível somente no modelo A1.


Painel
titlePuSiscomex.INI

[PROFILE_E-CPF_A1]
RoleType=DEPOSIT


[CERTIFICATE_E-CPF_A1]
SiscomexCertFile=C:\TFS\SARA\Services\config\CertificadoDigital\CCT\cert.pem
SiscomexKeyFile=C:\TFS\SARA\Services\config\CertificadoDigital\CCT\privatekey.pem
SiscomexRootCertFile=C:\TFS\SARA\Services\config\CertificadoDigital\CCT\publiccert.pem


[PROFILE_E-CNPJ_A1]
RoleType=DEPOSIT


[CERTIFICATE_E-CNPJ_A1]
SiscomexCertFile=C:\TFS\SARA\Services\config\CertificadoDigital\MR\cert.pem
SiscomexKeyFile=C:\TFS\SARA\Services\config\CertificadoDigital\MR\privatekey.pem
SiscomexRootCertFile=C:\TFS\SARA\Services\config\CertificadoDigital\MR\publiccert.pem


NOTA: É possível ativar ou desativar uma ou mais mensagens de integração com o Módulo Recintos, abaixo segue alguns exemplos:


Bloco de código
languagesql
titleAtivar ou Desativar Mensagens
/*Desativar a integração de todas as mensagens do CCT*/
update tab_eai_external_application set eea_active = 1 where eea_id = 2

/*Desativar a integração da mensagem da Unitização de Carga*/
update tab_eai_transaction set et_active = 1 where eea_id = 2 and et_id = 10

Parametrização do endereço base para a integração com o PUCOMEX - Módulo Recintos

Para informar o endereço base para a integração com o PUCOMEX, basta realizar o comando SQL abaixo informando o endereço no campo eea_address_base.


Bloco de código
languagesql
titleComando SQL
update tab_eai_external_application 
	set eea_address_base = 'https://val.portalunico.siscomex.gov.br' 
where eea_id = 2
Totvs custom tabs box items
defaultno
referenciaeventos
Totvs custom tabs box
tabsCredenciamento de Pessoas, Acesso de Pessoas, Credenciamento de Veículos, Agendamento de Veículos, Acesso de Veículos
idsCredenciamentoPessoa,AcessoPessoa,CredenciamentoVeiculo,AgendamentoVeiculo,AcessoVeiculo
Totvs custom tabs box items
defaultyes
referenciaCredenciamentoPessoa

Objetivo

Efetuar o envio das informações referente ao credenciamento de pessoas para o Módulo Recintos do PUCOMEX.

Estão previstas as operações de inclusão, retificação e cancelamento do credenciamento de pessoas.

A integração será realizada quando:

  • Na inclusão de uma pessoa. Nesta operação será realizada a integração de INCLUSÃO.
  • Na edição de uma pessoa. Nesta operação será realizada a integração de RETIFICAÇÃO.
  • Na exclusão de uma pessoa. Nesta operação será realizada a integração de CANCELAMENTO.


Independente da rotina de cadastro, a pendência para a integração será gerada por meio da trigger de insert, update ou delete vinculada a tabela "tab_pessoas".

Atualmente não existe nenhuma restrição quando ao registro de pessoas, ou seja, qualquer pessoa cadastrada no sistema TLRA deverá ser realizada a integração com o módulo recintos.


Manual da API de integração referente ao Credenciamento de Pessoas https://docs.portalunico.siscomex.gov.br/swagger/rcnt.html#/Servi%C3%A7os%20destinados%20%C3%A0%20recep%C3%A7%C3%A3o%20de%20eventos%20aduaneiros./incluir_10

Pré-requisitos

Para que a integração seja realizada, será necessário um mapeamento DE-PARA para a informação do PAÍS. O sistema PUCOMEX espera um código de país conforme tabela abaixo:

View file
namePucomex_Pais.pdf
height150


O registro DE-PARA, deverá ser realizado por meio do módulo SISTEMA, menu CADASTRO | DE-PARA.

Deverá ser informado o nome do PAÍS registrado no sistema TLRA e o código do país conforme tabela do SISCOMEX. 

No processo de instalação, existe um script que irá incluir de forma automática os países da América do Sul, caso necessite da inclusão de mais países, este registro poderá ser feito de forma manual.


Procedimento de Utilização (Sistema TLRA)

  1. No sistema TLRA, efetuar o registro, edição ou cancelamento do cadastro de uma pessoa por meio dos módulos controle de acesso ou portaria. 
  2. Acessar o EAIMonitor para identificar se a integração foi realizada com o módulo recintos. Em caso de dúvidas, acessar o manual técnico referente ao módulo EAI Monitor por meio do link EAI Monitor Viewer | Manual Técnico.
Totvs custom tabs box items
defaultno
referenciaAcessoPessoa

Objetivo

Efetuar o envio das informações referente ao acesso de pessoas para o Módulo Recintos do PUCOMEX.

Estão previstas as operações de registro de entrada ou saída de uma pessoa do recinto de forma manual ou automática por meio de pontos de acesso eletrônicos (Catracas, Torniquetes entre outros).


A integração será realizada quando:

  • Na entrada de uma pessoa no recinto aduaneiro. Nesta operação será realizada a integração de INCLUSÃO.
  • Na saída de uma pessoa no recinto aduaneiro. Nesta operação também será realizada a integração de INCLUSÃO.


NOTA: Por meio do sistema atualmente não é possível retificar ou cancelar uma entrada ou saída de pessoas.


Independente da rotina de registro de acesso, a integração será gerada por meio da trigger das triggers de "insert ou update" vinculada a tabela "tab_acessos".

Atualmente não existe nenhuma restrição quando ao registro de acesso de pessoas, ou seja, qualquer pessoa  que entrar ou sair do recinto deverá ser realizada a integração com o módulo recintos, independe do tipo de acesso (motorista, funcionário, Fiscal da RFB, despachante entre outros.)


Manual da API de integração referente Acesso de Pessoas Pessoas: https://docs.portalunico.siscomex.gov.br/swagger/rcnt.html#/Servi%C3%A7os%20destinados%20%C3%A0%20recep%C3%A7%C3%A3o%20de%20eventos%20aduaneiros./incluir_37

Procedimento de Utilização (Sistema TLRA)

  1. No sistema TLRA, efetuar o registro de um acesso de entrada ou saída para uma pessoa por meio dos módulos controle de acesso (manual) ou de forma automática por meio dos pontos de acesso eletrônicos (catracas/torniquetes entre outros.).
  2. Acessar o EAIMonitor para identificar se a integração foi realizada com o módulo recintos. Em caso de dúvidas, acessar o manual técnico referente ao módulo EAI Monitor por meio do link EAI Monitor Viewer | Manual Técnico.
Totvs custom tabs box items
defaultno
referenciaCredenciamentoVeiculo

Objetivo

Efetuar o envio das informações referente ao credenciamento de veículos (Rodoviário ou Ferroviário) para o Módulo Recintos do PUCOMEX.

Estão previstas as operações de inclusão, retificação e cancelamento do credenciamento de veículos (Rodoviário ou Ferroviário).

A integração será realizada quando:

  • Na inclusão de uma veículo (rodoviário ou ferroviário). Nesta operação será realizada a integração de INCLUSÃO.
  • Na edição de uma veículo (rodoviário ou ferroviário). Nesta operação será realizada a integração de RETIFICAÇÃO.
  • Na exclusão de um veículo (rodoviário ou ferroviário). Nesta operação será realizada a integração de CANCELAMENTO.


Independente da rotina de cadastro, a pendência para a integração será gerada por meio da trigger de insert, update ou delete vinculada a tabela "tab_veiculos".


Para a geração da pendência, o registro de veículos deverá possuir as seguintes informações:

  • Modal deverá ser rodoviário ou ferroviário.
  • Para veículos rodoviários deverão ser transmitidos veículos motorizados (trator) ou semireboques.
  • Para veículos ferroviários deverão ser transmitidos os vagões e as locomotivas (se for o caso).
  • Deverá ser enviado um evento por placa credenciada.


Manual da API de integração referente ao Credenciamento de Veículos: https://docs.portalunico.siscomex.gov.br/swagger/rcnt.html#/Servi%C3%A7os%20destinados%20%C3%A0%20recep%C3%A7%C3%A3o%20de%20eventos%20aduaneiros./incluir_7

Procedimento de Utilização (Sistema TLRA)

  1. No sistema TLRA, efetuar o registro de um veículo por meio dos módulos portaria, Portal WEB (Agendamento de veículos), ou outra rotina que efetue a inclusão de um veículo de transporte.
  2. Acessar o EAIMonitor para identificar se a integração foi realizada com o módulo recintos. Em caso de dúvidas, acessar o manual técnico referente ao módulo EAI Monitor por meio do link EAI Monitor Viewer | Manual Técnico.
Totvs custom tabs box items
defaultno
referenciaAgendamentoVeiculo

Objetivo

Efetuar o envio das informações referente ao agendamento de veículos (Rodoviário ou Ferroviário) para o Módulo Recintos do PUCOMEX.

Estão previstas as operações de inclusão, retificação e cancelamento do agendamento de veículos (Rodoviário ou Ferroviário).

A integração será realizada quando:

  • Efetuar a liberação de um agendamento para um veículo (Rodoviário ou Ferroviário) na rotina de liberação de agendamentos. No sistema TRLA, a liberação de agendamentos está disponível no processo de agendamento do Portal WEB, no Transit-time triagem do módulo portaria ou na API de liberação de agendamento.
  • Ao efetuar um estorno da liberação do agendamento, o sistema efetuará uma integração de cancelamento do agendamento. Após nova liberação será realizada a inclusão de um novo registro de agendamento.
  • Ao efetuar um cancelamento de um agendamento de veículos (Rodoviário ou Ferroviário), o sistema efetuará uma integração de cancelamento do agendamento.
  • Ao editar alguma informação de um agendamento já liberado, o sistema irá gerar uma retificação do agendamento.
  • Ao efetuar um estorno de um cancelamento de agendamento, o sistema efetuará novamente a integração de inclusão de um novo agendamento.

Independente da rotina de cadastro, a pendência para a integração será gerada por meio das triggers de "insert, update ou delete" vinculada a tabela "tab_programacao".


Para a geração da pendência, o registro do agendamento de veículos deverá possuir as seguintes informações:

  • Modal deverá ser rodoviário ou ferroviário.
  • Deverá ser executada a rotina de liberação do agendamento.


Para o agendamento de veículo, a API de integração é o mesmo "endpoint" da API de acesso de veículos.

Manual da API de integração referente ao Agendamento de Veículos: https://docs.portalunico.siscomex.gov.br/swagger/rcnt.html#/Servi%C3%A7os%20destinados%20%C3%A0%20recep%C3%A7%C3%A3o%20de%20eventos%20aduaneiros./incluir_8

Procedimento de Utilização (Sistema TLRA)

  1. No sistema TLRA, efetuar a liberação de um agendamento de veículo. No sistema TRLA, a liberação de agendamentos está disponível no processo de agendamento do Portal WEB, no Transit-time triagem do módulo portaria ou na API de liberação de agendamento.
  2. Acessar o EAIMonitor para identificar se a integração foi realizada com o módulo recintos. Em caso de dúvidas, acessar o manual técnico referente ao módulo EAI Monitor por meio do link EAI Monitor Viewer | Manual Técnico.
Totvs custom tabs box items
defaultno
referenciaAcessoVeiculo

Objetivo

Efetuar o envio das informações referente ao acesso de veículos (Rodoviário ou Ferroviário) para o Módulo Recintos do PUCOMEX.

Estão previstas as operações de entrada e saída, retificação e cancelamento do acesso de veículos (Rodoviário ou Ferroviário).

A integração será realizada quando:

  • Efetuar a entrada ou a saída de veículo (rodoviário ou ferroviário) do recinto por meio do sistema TLRA, antes SARA.
  • Efetuar um cancelamento do CESV (Controle de entrada ou saída de veículos), desta forma o sistema irá gerar uma integração para o cancelamento do acesso.
  • Efetuar o fechamento de uma ordem de serviço (Descarga ou Carga) vinculada ao veículo. Desta forma o sistema efetuará a integração com a operação "Retificação" da entrada complementando as informações relacionadas a entrada do veículo.
  • Ao efetuar a saída de um veículo do recinto.


Independente da rotina de entrada ou saída de veículos, a pendência para a integração será gerada por meio da trigger de insert, update ou delete vinculada a tabela "tab_cesv".


Para a geração da pendência, o registro de entrada ou saída de veículos deverá possuir as seguintes informações:

  • Modal deverá ser rodoviário ou ferroviário.
  • Possuir entrada ou saída do recinto.


Manual da API de integração referente ao Agendamento de Veículos: https://docs.portalunico.siscomex.gov.br/swagger/rcnt.html#/Servi%C3%A7os%20destinados%20%C3%A0%20recep%C3%A7%C3%A3o%20de%20eventos%20aduaneiros./incluir_4

Procedimento de Utilização (Sistema TLRA)

  1. No sistema TLRA, efetuar a entrada ou a saída de veículo no recinto. 
  2. Para a retificação complementando as informações de documentos, contêineres entre outros, efetuar a ordem de serviço vinculada a entrada do veículo (Descarga ou Carga).
  3. Acessar o EAIMonitor para identificar se a integração foi realizada com o módulo recintos. Em caso de dúvidas, acessar o manual técnico referente ao módulo EAI Monitor por meio do link EAI Monitor Viewer | Manual Técnico.



...