Integração Checklist x Ocorrência de Entrega Automática x Comprovante Entrega (Integrações - SIGATMS)

CONTEÚDO

01. VISÃO GERAL

O aplicativo Meu Checklist permite que sistemas externos produzam Check Lists (listas de verificações) para serem apontados via mobile - na integração entre o Módulo TOTVS Logística TMS e o App Meu Checklist, esta rotina permite complementar o processo de Apontamento do Comprovante de Entrega, possibilitando obter os dados obrigatórios para a transmissão do evento de comprovante de entrega para a SEFAZ (Secretaria da Fazenda).

Atualmente os dados considerados obrigatórios seguindo a NT 2019.001 para a transmissão do evento do comprovante de entrega são:

• Descrição do Evento;
• Número do protocolo de autorização do CT-e;
• Data e Hora da Conclusão da Entrega;
• Documento de identificação da pessoa que recebeu a entrega;
• Nome da pessoa que recebeu a entrega;
• HashEntrega: Refere-se a concatenação de Chave de acesso do CT-e + Base64 da imagem capturada da entrega (Exemplo: imagem capturada da assinatura eletrônica, digital do recebedor, foto, etc);
• Data e hora da geração do hash da entrega;
• Chave de acesso da NF-e que está sendo entregue.
  
  

02. CONFIGURAÇÕES

Parâmetros

Para habilitar a integração do My Checklist com as ocorrências de entrega automática e o Comprovante de Entrega, é necessário configurar os seguintes parâmetros:

• MV_TMAPCKL: com o valor .T. (Habilitado).
• MV_TMINTEV: com o valor 1-Fechamento da Viagem ou 2-Saída de Filial. Para definir quando será iniciada a integração com o Checklist.
• MV_OCORENT: define a ocorrência de entrega no apontamento automático de ocorrências. A integração utiliza esse parâmetro para apontar a ocorrência do tipo encerra processo, ao processar o retorno do documento entregue.

Schedule

Para o perfeito funcionamento do Checklist é necessário que haja a sincronização dos dados apontados via aplicação App Mobile do My Checklist.

O sincronismo ocorre por meio do Job localizado na rotina Sincronizador da Integração do My Checklist x Ocorrência de Entrega Automática x Comprovante de Entrega (TMSAE81).

Para a configuração do Job, acesse o módulo Configurador (SIGACFG) do Protheus e execute os seguintes passos:

1. Configuração do Agente do Schedule

a. Acesse o Agente do Schedule via menu Ambiente > Schedule > Schedule.

b. No menu lateral, clique no ícone Agent e, em seguida, na opção Cadastro.

c. Na parte inferior da tela Detalhes, clique no ícone representado por uma página com o sinal de mais , preencha os campos, conforme quadro Campos Agent Schedule detalhado logo abaixo.

d. Salve o cadastro, clicando no ícone representado pela imagem de check na cor verde .

2. Configuração do Job

a. Acesse o Cadastro de Agendamentos de Rotinas via menu Ambiente > Schedule > Schedule.

b. No menu lateral, clique no ícone com o título de Agendamentos para expandir;.

c. Ainda em Agendamentos, clique em Cadastro.

d. Na parte inferior da tela Detalhes, clique no ícone representado por uma página com o sinal de mais . 

e. Para incluir um novo registro, preencha os campos, conforme o quadro Campos Cad. Job.

f.  Salve o cadastro, clicando no ícone representado pela imagem de check na cor verde .

3. Configuração Sem o uso do Job

Existe a possibilidade de inclusão da rotina Busca Checklist (TMSAE81) diretamente no menu do Módulo TOTVS Logística TMS, porém a execução passará a ser manual, não ocorrendo assim o sincronismo automático do retorno de dados do My Checklist.

a. Uma vez no módulo Configurador, acesse Ambiente > Cadastros > Menus;

b. Na janela aberta, localize na listagem "TMS - Gestão de Transportes";

c. Clique em OK;

d. Clique em adicionar, para ajuste do novo menu;

e. Sugerimos que seja selecionado o grupo "Ocorrências" e em seguida, acionado a opção/botão "Novo Item";

f. Na nova janela, inclua a descrição da rotina "Busca Checklist", em programa digite "TMSAE81", em Módulo procure por "TMS - Gestão de Transportes" e em tipo informe "Função Protheus";

g. Clique em OK;

h. No retorno a tela principal, selecione opção/botão "Gerar";

i. Digite "SIGATMS";

j. Clique em "Gerar";

k. Confirme a geração do menu, clicando em "Sim".

l. No caso de solicitação de criação de backup pelo sistema, confirme clicando em "Sim".

m. Processo realizado, bastando sair da tela de configuração.

Importante: Com a utilização do processo somente via rotina no menu, a execução do processo passa a ser manual, desta forma será necessário a execução da rotina para consulta afim de verificar se há dados de retorno no App My Checklist para assim atualizar dados no Módulo  TOTVS Logística TMS, desde que também não exista um processo automático configurado no Schedule.

03. EXEMPLO DE UTILIZAÇÃO

No exemplo a seguir serão descritos os passos necessários para a utilização da integração do My Checklist x Ocorrência de Entrega Automática x Comprovante de Entrega:

Configuração Inicial

1.  Habilite a integração por meio do parâmetro MV_TMAPCKL, alterando o seu valor para .T. (true=habilitado), conforme explicado na seção 02.CONFIGURAÇÕES. A integração pode ocorrer em dois momentos distintos e depende da configuração do parâmetro MV_TMINTEV mencionado na seção 02.CONFIGURAÇÕES, sendo: 1 - no  Fechamento da Viagem ou 2 - na Saída de Filial.
   
   
2.  Certifique-se que o parâmetro MV_OCORENT está configurado com o código de Ocorrência do tipo Encerra processo e que a ocorrência também esteja configurada para gerar Comprovante de Entrega, campos Comp .Entrega DT2_CMPENT = '1' e Tipo DT2_TIPOCO='01'. Além disso a Categoria da ocorrência DT2_CATOCO =  deverá ser "1 - Por Documento".
   
3. Deverá existir ao menos um cadastro de motorista que esteja integrado ao Checklist, para isto na rotina Cadastro de Motoristas (OMSA040), acessar a aba "Outros" e no campo Login App (DA4_APPLOG) vincular o ID de integração com Checklist. 
   
   

4. Acessar Atualizações > Ocorrências > Configurações CheckList (TMSAC10), deverá ser incluído o cadastro de configuração para uso no app Meu Checklist - neste cadastro serão informados dados como filial para integração, URL's responsáveis pela conexão da integração, usuário e senha autorizados a validar e alterar dados no Portal Checklist, entre outras informações.

Configuração Appserver.ini

O arquivo appserver.ini deve conter as chaves abaixo:

Na sessão [Environment] :

MemoMega>1
TopMemoMega=2

Além disso segue abaixo exemplo de configuração REST que deverá ser configurada:

[ONSTART]
JOBS=FW_MANAGER,FW_QUEUE,REST_JOB

[FW_MANAGER]
MAIN=FWSCHDMANAG
ENVIRONMENT=P1227

[FW_QUEUE]
MAIN=FWSCHDQUEUE
ENVIRONMENT=P1227

[REST_JOB]
MAIN=HTTP_START
ENVIRONMENT=P1227

[HTTPV11]
ENABLE=1
Sockets=HTTPREST
MAXSTRINGSIZE=500

[HTTPREST]
Port=1225
SECURITY=0
URIs=HTTPURI1
IPsBind=

[HTTPURI1]
URL=/rest
PrepareIn=T1,M SP 01
Instances=1,2
ENVIRONMENT=P1227
CORSEnable=1
AllowOrigin=*                                                                                                 

[WebApp/webapp]
MPP=

Obs.: Os exemplos acima contém apenas os valores referentes a integração com Checklist.

Para melhor aproveitamento e em caso de dúvidas recomendamos a leitura da documentação sobre REST.

Processo Básico de Viagem no Protheus

1. Inclusão de Documentos

a.  Inclua um Documento de Entrada via menu Atualizações > Recebimento > Documento Entrada Clientes.

b.  Calcule o Frete para gerar um ou mais documentos de CT-e.

c.  Transmita o CT-e e aguarde a autorização pela SEFAZ;

2. Inclusão da Viagem

a.  Inclua uma viagem do tipo entrega por meio do menu Atualizações > Viagens > Rodoviário Entrega > Viagens(modelo 2).

b.  Clique em Incluir para abrir a tela de Cadastro de Viagem.

c.  Informe a rota que será utilizada.

d.  Clique em Outras Ações > Comp. via. para informar o(s) veículo(s) por meio da tela de Complemento da Viagem.

e.  Ainda na tela de Complemento da Viagem, clique em Outras Ações > Mot. Viag. para informar o motorista da viagem. Neste passo é importante incluir um motorista que esteja integrado ao processo do Checklist, conforme explicado na seção Configuração Inicial.

f.  Confirme a tela de Motorista, clicando em Salvar.

g.  Confirme a tela Complemento da Viagem, clicando em Salvar.

h.  Na tela da viagem, inclua os documentos que serão entregues por meio do grid. Pode ser utilizada a lupa pressionando a tecla F3, ao selecionar o campo Fil. Docto. Isso fará com que seja exibida a tela de seleção de documentos de transportes. Selecione os documentos que serão carregados na viagem.

i.  Com os documentos informados na viagem, clique em Salvar para confirmar os dados e gerar a viagem no sistema.

j. O processo de integração ocorrerá de acordo com a configuração do parâmetro MV_TMINTEV,  onde quando configurado como 1 a integração ocorrerá no Fechamento da Viagem sendo detalhada no item 3. abaixo, já quando o parâmetro estiver configurado como 2 a integração ocorrerá no Saída da Viagem sendo detalhada no item 4. abaixo:

3. Fechamento da Viagem e Integração Com My Checklist 

a.  Quando MV_TMINTEV = 1-Fechamento da Viagem.

b.  Posicione sobre a viagem incluída e acesse o menu Outras Ações > Manutenção > Fechamento > Fechar. Na tela de confirmação, clique em OK.

c.  Neste momento será realizado o fechamento da viagem e, estando configurado a integração com o My Checklist, será realizado a inclusão de registros na tabela   DLY - Evento do Comprovante de Entrega para cada documento de CT-e.

d.  Após a inclusão dos registros na tabela DLY - Eventos do Comprovante de Entrega será realizada a tentativa de integração com o My Checklist.

e.  A integração será disparada para cada documento, uma vez que cada checklist representa um CT-e que será enviado para o App Mobile do Checklist.

f. Será apresentado alerta informando que a integração ocorreu com sucesso, listando os documentos que foram integrados.

4.  Saída da Viagem e Integração Com My Checklist

a.  Quando MV_TMINTEV = 2-Saída da Viagem.

b.  Posicione sobre a viagem incluída e acesse o menu Outras Ações > Manutenção > Operações. 

c.  Na tela de Apontamento de Operações, selecione a operação de Saída de Viagem e clique em Apontar.

d.  Informe os campos de Dt. Início/Hr .Início e Dt. Realizada/Hr. Realizada.

e.  Clique em Confirmar para registrar o apontamento de Saída.

f.  Após a confirmação do apontamento será realizada a tentativa de integração com o My Checklist, ocorrendo primeiro a inclusão de registros na tabela DLY - Evento do Comprovante de Entrega para cada documento de CT-e.

g.  Em seguida, as informações do CT-e serão enviadas para o My Checklist;.

h.  A integração será disparada para cada documento, uma vez que cada checklist representa um CT-e que será enviado para o App Mobile do Checklist.

i.   Será apresentado alerta informando que a integração ocorreu com sucesso, listando os documentos que foram integrados.

5. Atualização dos Dados do Comprovante de Entrega Via JOB

a.  A sincronização dos dados via Job é realizada ao configurar a rotina TMSAE81B - Sincronizador Checklist x Comprovante de Entrega via módulo Configurador (SIGACFG).

b.  Uma vez no módulo Configurador, acesse a interface do Schedule pelo caminho Ambiente > Schedule > Schedule.

c.  Siga os passos descritos na seção 02.CONFIGURAÇÕES > Schedule.

d.  O Job se encarrega de realizar as seguintes tarefas: 

i.  Lista os registros da tabela DLY - Eventos do Comprovante de Entrega com o status=0-Integrado, verificando se existem apontamentos realizados via App My Checklist;

ii.  Efetua a integração com o Checklist, caso não tenha ocorrido a integração no momento da fechamento da viagem ou na saída de viagem de acordo com a configuração do parâmetro MV_TMINTEV.

iii. Efetua o apontamento de ocorrências de entrega no Módulo TOTVS Logística TMS e por fim atualiza as informações de recebedor, documento e imagem da tabela DLY Evento do Comprovante de Entrega para cada documento de CT-e.

Processo Transbordo de Viagem no Protheus

A viagem de Socorro é utilizada para o trânsito de veículos sem carga, para situações de veículos quebrados ou na necessidade de transbordo, por exemplo.

Desta forma, no processo de viagem de transbordo quando há a integração com o Checklist, os passos 1 à 5 listados acima deverão ter sido executados previamente, entende-se que a viagem esteja com status "Em trânsito".

Neste cenário:

a. Deve existir previamente uma ocorrência cadastrada do tipo 08 - Transferência de Viagem com categoria "Por documento";

b. Mais de um cadastro de motorista vinculado ao Checklist;

1. Viagem de transbordo - entregas parciais realizadas

Supondo neste cenário a existência de uma viagem inicial integrada com processo de Checklist, onde o carregamento inicial de 5 documentos (CTe's) e no trajeto seguido ocorreram 3 entregas com sucesso, restando a assim a execução de 2 entregas para o motorista vinculado ao Checklist;

a. Inclua uma viagem do tipo Socorro por meio do menu Atualizações > Viagens > Rodoviário Entrega > Viagens(modelo 2).

b. Informe a rota que será utilizada.

c.  Clique em Outras Ações > Comp. via. para informar o(s) veículo(s) por meio da tela de Complemento da Viagem.

d. Ainda na tela de Complemento da Viagem, clique em Outras Ações > Mot. Viag. para informar o motorista da viagem. Neste passo é importante incluir um motorista que esteja integrado ao processo do Checklist e diferente do motorista da primeira viagem.

e. Confirme a tela de Motorista, clicando em Salvar.

f. Confirme a tela Complemento da Viagem, clicando em Salvar.

g. Retorne e posicione a viagem inicial, que continha inicialmente 5 documentos para entrega, Outras Ações > Manutenção > Reg. de Ocorrência realize o apontamento da ocorrência do tipo 08 - Transferência de Viagem para os documentos não entregues, informando a nova viagem de socorro que executará o processo de entrega dos documentos faltantes.

h. Estes documentos não ficarão pendentes para o motorista da primeira viagem na integração Checklist, sendo assim cancelados no Portal de Integração.

i. Retornando a viagem de socorro, estará com status "em aberto" e com os documentos não entregues adicionados a viagem.

j. O processo de integração ocorrerá de acordo com a configuração do parâmetro MV_TMINTEV,  onde quando configurado como 1 a integração ocorrerá no Fechamento da Viagem sendo detalhada no item 3. acima, já quando o parâmetro estiver configurado como 2 a integração ocorrerá no Saída da Viagem, sendo detalhada no item 4. acima.

k. Neste cenário, os documentos constantes na viagem de socorro passarão a constar no Portal e no App Mobile do Checklist vinculados ao segundo motorista e veículo (registrados no complemento da viagem de socorro).

2. Viagem de transbordo - entregas não realizadas

Supondo neste cenário a existência de uma viagem inicial integrada com processo de Checklist, onde o carregamento inicial de 5 documentos (CTe's), no trajeto seguido ocorre a quebra do veículo (viagem inicial) sendo neste cenário nenhuma entrega realizada com sucesso.

a. Inclua uma viagem do tipo Socorro por meio do menu Atualizações > Viagens > Rodoviário Entrega > Viagens(modelo 2).

b. Informe a rota que será utilizada.

c.  Clique em Outras Ações > Comp. via. para informar o(s) veículo(s) por meio da tela de Complemento da Viagem.

d. Ainda na tela de Complemento da Viagem, clique em Outras Ações > Mot. Viag. para informar o motorista da viagem. Neste passo é importante incluir um motorista que esteja integrado ao processo do Checklist e diferente do motorista da primeira viagem.

e. Confirme a tela de Motorista, clicando em Salvar.

f. Confirme a tela Complemento da Viagem, clicando em Salvar.

g. Retorne e posicione a viagem inicial, que continha inicialmente 5 documentos para entrega, Outras Ações > Manutenção > Reg. de Ocorrência realize o apontamento da ocorrência do tipo 08 - Transferência de Viagem para os documentos não entregues (neste cenário, todos os documentos da viagem).

h. Estes documentos não ficarão pendentes para o motorista da primeira viagem na integração Checklist, sendo assim cancelados no Portal de Integração.

i. Retornando a viagem de socorro, estará com status "em aberto" e com os documentos não entregues adicionados a viagem.

j. O processo de integração ocorrerá de acordo com a configuração do parâmetro MV_TMINTEV,  onde quando configurado como 1 a integração ocorrerá no Fechamento da Viagem sendo detalhada no item 3. acima, já quando o parâmetro estiver configurado como 2 a integração ocorrerá no Saída da Viagem, sendo detalhada no item 4. acima.

k. Neste cenário, os documentos constantes na viagem de socorro passarão a constar no Portal e no App Mobile do Checklist vinculados ao segundo motorista e veículo (registrados no complemento da viagem de socorro).

Processo Estorno de Viagem no Protheus

O processo de estorno de viagem quando há a integração com o Checklist  é o mesmo processo quando não há a integração ativa.

Desta forma, a única diferença é: quando ocorre o estorno do processo do fechamento da viagem ou da operação de saída, os documentos constantes na viagem são cancelados no Portal e no App Mobile do Checklist, passando assim a ficar aptos para inclusão em novo Checklist.

Importante: o cancelamento no Portal e no App Mobile do Checklist, também segue o critério da configuração do parâmetro MV_TMINTEV,  onde quando configurado como 1 o cancelamento ocorrerá no Fechamento da Viagem, já quando o parâmetro estiver configurado como 2 o cancelamento ocorrerá no Saída da Viagem.

Caso a configuração do parâmetro MV_TMINTEV = 1:

a. Posicione sobre uma viagem com o status "fechada" por meio do menu Atualizações > Viagens > Rodoviário Entrega > Viagens(modelo 2).

b. Clique em Outras Ações > Manutenção > Fechamento > Estornar

c. O status da viagem passará para em "aberto", documentos integrados no Portal ficarão com status "cancelado" e no App Mobile do Checklist  são excluídos da listagem de entrega do motorista.

Caso a configuração do parâmetro MV_TMINTEV = 2:

a. Posicione sobre uma viagem com o status "em trânsito" por meio do menu Atualizações > Viagens > Rodoviário Entrega > Viagens(modelo 2).

b. Clique em Outras Ações > Manutenção > Operações 

c. Na janela aberta de apontamento de operações, posicione sobre o apontamento da operação de saída e clique no botão "estornar" localizado no rodapé da janela.

d.  Confirme na janela de estorno de operações.

e. O status da viagem passará para "fechado", documentos integrados no Portal ficarão com status "cancelado" e no App Mobile do Checklist  são excluídos da listagem de entrega do motorista.

04. INTEGRAÇÃO - VISÕES: PORTAL e  APP MOBILE (MOTORISTA)

Durante o processo de integração, ocorrerão as seguintes visões no Portal e na Tela do App Mobile Checklist:

Visão do Checklist (Portal):

Documentos são apresentados no Portal para o usuário responsável pelo acompanhamento (isso ocorrerá a partir da confirmação da integração - após o fechamento ou após a operação de saída de viagem, definidos de acordo com a configuração do parâmetro MV_TMINTEV :

Telas – Visão do Motorista (etapas no app):

No modo mobile apresentado ao motorista para execução de tarefas:

1. Apresentação do documento a ser realizado o Checklist;

2. Início do processo Checklist;

3. Primeira pergunta, documento entregue?

4. Caso, positivo incluir evidência, neste passo o motorista deverá incluir uma foto do comprovante de entrega;

5. Segunda pergunta, informar o nome do recebedor;

6. Terceira pergunta, informar o nº de documento deste recebedor;

7. Tela para confirmação da finalização do Checklist.

Neste momento, após o registro do motorista:

1. O documento aparecerá com status de “Finalizado” no Portal do Checklist.

2. Ocorrerá o apontamento automático da ocorrência cadastrada no parâmetro MV_OCORENT para os documentos constantes na viagem TMS;

3. Será atualizada a tabela DLY ( Eventos do Comprovante de Entrega) gravando os dados do nome, documento e a imagem inserida no Checklist.

4. Documento apto para transmissão a SEFAZ.
Podendo seguir o processo de envio do comprovante de entrega padrão.

05. ESTORNO INTEGRAÇÃO - VISÕES: PORTAL e  APP MOBILE (MOTORISTA)

Durante o processo de estorno da  integração, ocorrerão as seguintes visões no Portal e na Tela do App Mobile Checklist:

Visão do Checklist (Portal):

1. Necessário que os documentos já estejam integrados e com status "pendente de execução".

2. Após o  processo de estorno do fechamento da viagem ou estorno da operação de saída de viagem, definidos de acordo com a configuração do parâmetro MV_TMINTEV, o status do documento passará para "Cancelado":

Telas – Visão do Motorista (etapas no app):

1. Ao realizar o processo de estorno no Módulo  TOTVS Logística TMS, documentos serão também removidos do App My Checklist do motorista (celular);

06. TABELAS UTILIZADAS

DLZ - Configurações Checklist

DLY - Eventos do Comprovante de Entrega

DM0 - Imagens Comprovante de Entrega

DT2 -  Tabelas de Ocorrências

DT6 - Documentos de Transporte

DTQ - Viagens

07. ASSUNTOS RELACIONADOS

Configurações CheckList (TMSAC10 - SIGATMS)

Integração Meu Check-List x Ocorrência de Entrega x Documentos Não Fiscais (Integrações - SIGATMS)

Automação do Apontamento de Ocorrências (TMSA360 - SIGATMS)

Comprovante de Entrega Eletrônico (TMSAE71 - SIGATMS)

Configurando Mapa de gerenciamento de Viagens com Checklist (Open Street)

Schedule Vínculo de Imagem

Parâmetros SIGATMS