JOBS: Envio e Retorno (TMSAI86 / TMSAI87 - SIGATMS)

CONTEÚDO

01. VISÃO GERAL

Para funcionamento de forma automática de envios e retornos de informações do Coleta Entrega é necessário que haja a sincronização dos dados apontados via aplicação App Mobile do Coleta Entrega.

O sincronismo ocorre por meio dos Jobs localizados nas rotinas de Jobs: Envio e Retorno (TMSAI86 / TMSAI87 - SIGATMS).

Observação:

As integrações abaixo utilizam-se apenas do Job de Envio (TMSAI86):

TOTVS Logística TMS x TOTVS Portal Logístico;
TOTVS Faturamento x Coleta Entrega;

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

1.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 .

Campos Agent Schedule
Campo	Descrição
Nome	Informe o nome do agente que faz o gerenciamento das execuções das threds/jobs agendados. Exemplo: Agente de Execução Empresa T1.
IP	Informe o IP do servidor, que deve ser o mesmo que está executando o Appserver. Também pode ser o localhost ou o nome da máquina servidora.
Porta	Informe a mesma porta de execução do Appserver que fará o controle de execução dos Jobs.
Ambiente	Informe o ambiente configurado no Appserver.ini.
Empresa	Informe o grupo da empresa. Utilize a lupa para selecionar o código da empresa.
Nº de Threads	Informe a quantidade de Threads que será gerenciada pelo agente do Schedule. É permitido executar em paralelo uma ou mais rotinas. Exemplo: Se for informado 3 Threads o agente fará o gerenciamento da execução de até 3 rotinas em paralelo.
Habilitado	Quando assinalado, o Agente é habilitado na próxima vez que o Appserver for iniciado.

1.2 Configuração dos Jobs (ENVIO e RETORNO)

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 .

Campos Cad. Job
Campo	Descrição
Usuário	Código do usuário que tenha direitos de Administrador. Utilize o botão representado por uma lupa para abrir a lista de usuários.
Rotina	Nome da rotina do Job. Informe a rotina TMSAI86 (Função auxiliar do Job Envio Coleta entrega - Envio).
Data	Informe a data de início da execução do Job no formato DD/MM/YYYY. Exemplo: 26/10/2022
Hora	Informe a hora que será iniciada a execução da rotina, deve estar no formato HH:MM. Exemplo: 10:07.
Ambiente	Informe o ambiente configurado do Appserver.
Empresa/Filial	Informe o grupo de empresa e Filial. Utilize a lupa ao lado do campo para abrir a tela de Wizard, para seleção da empresa e filial.
Módulo	Informe o código do Módulo que, neste caso, deve ser o 43 - TMS Gestão de Transporte.
Habilitada	Quando assinalado, indica que o Job está habilitado.
Descrição	Texto livre. Por sugestão pode ser informado "Função auxiliar do Job Envio Coleta entrega Envio)".

Campos Cad. Job
Campo	Descrição
Usuário	Código do usuário que tenha direitos de Administrador. Utilize o botão representado por uma lupa para abrir a lista de usuários.
Rotina	Nome da rotina do Job. Informe a rotina TMSAI87 (Função de Job de retorno da integração Coleta Entrega).
Data	Informe a data de início da execução do Job no formato DD/MM/YYYY. Exemplo: 26/10/2022
Hora	Informe a hora que será iniciada a execução da rotina, deve estar no formato HH:MM. Exemplo: 10:07.
Ambiente	Informe o ambiente configurado do Appserver.
Empresa/Filial	Informe o grupo de empresa e Filial. Utilize a lupa ao lado do campo para abrir a tela de Wizard, para seleção da empresa e filial.
Módulo	Informe o código do Módulo que, neste caso, deve ser o 43 - TMS Gestão de Transporte.
Habilitada	Quando assinalado, indica que o Job está habilitado.
Descrição	Texto livre. Por sugestão pode ser informado "Função de Job de retorno da integração Coleta entrega".

Atenção

Caso seja necessário executar o procedimento diversas vezes, configure por meio do botão Recorrência, no entanto, não recomendamos a utilização de Recorrência sempre ativa, utilizar com tempo definido, como por exemplo, 1 minuto.

O schedule somente será executado se houver um agente cadastrado para a mesma empresa e seu serviço estiver acionado.
O uso do Schedule consome licença.

1.3 Configuração Sem o uso dos Jobs

Existe a possibilidade de inclusão das rotinas Envio e Retorno (TMSAI86 / TMSAI87 - SIGATMS), 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 Portal Coleta Entrega.

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 "Miscelânea > Integrações" e em seguida, acionado a opção/botão "Novo Item";

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

g. Clique em OK;

h. Acione novamente a opção/botão "Novo Item";

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

j. Clique em OK;

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

l. Digite "SIGATMS";

m. Clique em "Gerar";

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

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

p. 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 envio e/ou retorno no App Coleta Entrega 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.

02. OUTRAS CONFIGURAÇÕ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=P1233

[FW_QUEUE]
MAIN=FWSCHDQUEUE
ENVIRONMENT=P1233

[REST_JOB]
MAIN=HTTP_START
ENVIRONMENT=P1233

[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=P1233
CORSEnable=1
AllowOrigin=*

[WebApp/webapp]
MPP=

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

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

Alerta de risco

Fique atento ao utilizar o parâmetro de configuração com a chave Security=0, pois isso fará com que as integrações (APIs) não exijam autenticação, consequentemente dados do seu ambiente poderão ser consultados sem qualquer controle de autorização.

03. TABELAS UTILIZADAS

DN2 - Tipos de Registro
DN3 - Layout dos Registros
DNB - Herança ID Externo

04. ASSUNTOS RELACIONADOS

Árvore de páginas