01. DADOS GERAIS
Produto: | |
---|
Linha de Produto: | |
---|
Segmento: | |
---|
Módulo: | |
---|
Função: | FINA070 TMSA141 TMSA200 TMSA210 TMSA350 TMSA360 TMSA460 TMSA850 TMSAC30 TMSAF90 TMSAI86 TMSAI87 TMSXFUNC TMSXFUND TMSXFUNH TMSXSEFA |
---|
País: | Brasil |
---|
Requisito/Story/Issue (informe o requisito relacionado) : |
|
---|
02. SITUAÇÃO/REQUISITO
Disponibilizar a integração do produto TMS Protheus x Portal Logístico, via API REST, com objetivo de otimizar a gestão dos documentos de transporte e acompanhamento operacional em tempo real.
03. SOLUÇÃO
Realizado o desenvolvimento da integração TMS Protheus x Portal Logístico.
Prezado cliente, esta integração estará nativa no TMS Protheus apenas a partir da versão 12.1.2310. |
04. ATUALIZAÇÃO DO AMBIENTE
Para adequação do ambiente, se faz necessária atualização abaixo:
- Configuração da integração TMS Protheus x Portal Logístico na rotina;
- Atualização do dicionário de dados para criação de tabelas de controle da integração. Pacotes : 011015 (TMS x PORTAL LOGISTICO) ,010555 (TMS X COLETA ENTREGA).
Atualização de Dicionário de dados (Pacote 011015)
Índice | Ordem | Chave | Descrição | DND | 1 | DND_FILIAL+DND_CODCON+DND_SEQUEN | Config. Integração Portal Logistico |
|
Tabela | Descrição | DMR | Roteirização - TPR | DMS | Itens Roteirização - TPR |
|
Tabela DLU - Controle Integração Roteirização
Campo | DLU_RETENV | Tipo | Memo | Tamanho | 50 | Decimal | 0 | Formato |
| Título | Retorno Post | Descrição | Retorno do Envio do Post | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Nesse campo deve ser armazenado o JSON que retorna referente ao primeiro envio e/ou requisição. |
DLV- Cadastro Roteirizador Campo | DLV_AUTH | Tipo | Caractere | Tamanho | 50 | Decimal | 0 | Formato |
| Título | Authorizatio | Descrição | Chave de Autorização | Usado | Sim | Obrigatório | Sim | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Nesse campo deve ser informado a chave do Planejamento de Rotas (TPR) |
Campo | DLV_ROTERI | Tipo | Caractere | Tamanho | 18 | Decimal | 0 | Formato | @! | Título | Roteirizador | Descrição | Roteirizador | Usado | Sim | Obrigatório | Não | Browse | Não | Opções | 1=Maplink;2=Planejamento Rotas (TPR) | When |
| Relação |
| Val. Sistema | Pertence('12') | Help | Define o tipo de integração: 1=Maplink; 2=Planejamento Rotas (TPR) |
Campo | DLV_TOKEN | Tipo | Caractere | Tamanho | 254 |
Campo | DLV_URLCAL | Tipo | Caractere | Tamanho | 80 |
Campo | DLV_URLGEO | Tipo | Caractere | Tamanho | 254 | Decimal | 0 | Formato | @! | Título | URL Geocode | Descrição | URL da Geolocalização | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Informe a URL da Geolocalização |
Campo | DLV_URLROT | Tipo | Caractere | Tamanho | 254 | Decimal | 0 | Formato | @! | Título | URL Roteriza | Descrição | URL da Roteirização | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Informe a URL da Geolocalização |
Campo | DLV_URLTK | Tipo | Caractere | Tamanho | 254 | Decimal | 0 | Formato | @! | Título | URL Token | Descrição | URL Token | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Informe a URL da Geolocalização |
Campo | DLV_TMPEXP | Tipo | Caractere | Tamanho | 5 | Decimal | 0 | Formato | @R 999:99 | Título | Tempo Exp. | Descrição | Tempo de Expiração | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When | TMSAC20Whe() | Relação |
| Val. Sistema | TMSAC20Vld() | Help | Tempo de expiração para o cancelamento automático das Roteirizações Pendentes. O cancelamento será efetuado considerando a Data de Envio da Roteirização (DLU_DATENV e DLU_HORENV |
Campo | DLV_ROTA | Tipo | Caractere | Tamanho | 6 | Decimal | 0 | Formato | @! | Título | Rota | Descrição | Rota de Entrega | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When | TMSAC20Whe() | Relação |
| Val. Sistema | Vazio() .Or. TMSAC20Vld() | Help | Informe uma Rota do Tipo de Transporte Rodoviário e Serviço de Transporte de Entrega, que será utilizado na geração da Programação de Carregamento. |
Campo | DLV_DESROT | Tipo | Caractere | Tamanho | 30 | Decimal | 0 | Formato | @! | Título | Praça Princ. | Descrição | Praça Principal | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação | IF(!INCLUI,POSICIONE("DA8",1,XFILIAL("DA8")+DLV->DLV_ROTA,"DA8_DESC"),"") | Val. Sistema |
| Help | Indica a Praça Principal da Rota |
DMR - Roteirização TPR Campo | DMR_FILIAL | Tipo | Caractere | Tamanho | 2 | Decimal | 0 | Formato | @! | Título | Filial | Descrição | Filial do Sistema | Usado | Não | Obrigatório |
| Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Indica a Filial do Sistema |
Campo | DMR_FILROT | Tipo | Caractere | Tamanho | 2 | Decimal | 0 | Formato | @! | Título | Fil. Roteir. | Descrição | Filial Roteirização | Usado | Sim | Obrigatório | Sim | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Filial do Identificador da Roteirização |
Campo | DMR_IDROT | Tipo | Caractere | Tamanho | 9 | Decimal | 0 | Formato | @! | Título | Id.Roteir. | Descrição | Id. Roteirização | Usado | Sim | Obrigatório | Sim | Browse | Sim | Opções |
| When |
| Relação | GetSx8Num("DMR","DMR_IDROT") | Val. Sistema |
| Help | Identificador da Roteirização da Integração com o Planejamento de Rotas (TPR) |
Campo | DMR_STATUS | Tipo | Caractere | Tamanho | 1 | Decimal | 0 | Formato |
| Título | Status | Descrição | Status | Usado | Sim | Obrigatório | Sim | Browse | Não | Opções | 1=Pendente;2=Processado;3=Cancelado | When |
| Relação | '1' | Val. Sistema | Pertence('123') | Help | Status da Roteirização da Integração com o Planejamento de Rotas (TPR) |
DMS - Itens Roteirização TPR Campo | DMS_FILIAL | Tipo | Caractere | Tamanho | 2 | Decimal | 0 | Formato | @! | Título | Filial | Descrição | Filial do Sistema | Usado | Não | Obrigatório |
| Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Indica a Filial do Sistema |
Campo | DMS_FILROT | Tipo | Caractere | Tamanho | 2 | Decimal | 0 | Formato | @! | Título | Fil.Roteir. | Descrição | Filial Roteirização | Usado | Não | Obrigatório |
| Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Filial do Identificador da Roteirização |
Campo | DMS_IDROT | Tipo | Caractere | Tamanho | 9 | Decimal | 0 | Formato | @! | Título | Id.Roteir. | Descrição | Id. Roteirização | Usado | Não | Obrigatório |
| Browse |
| Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Identificador da Roteirização da Integração com o Planejamento de Rotas (TPR) |
Campo | DMS_ITEM | Tipo | Caractere | Tamanho | 6 | Decimal | 0 | Formato | @! | Título | Item | Descrição | Item | Usado | Sim | Obrigatório | Sim | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Identifica o item da roteirização |
Campo | DMS_ENTIDA | Tipo | Caractere | Tamanho | 3 | Decimal | 0 | Formato | @! | Título | Entidade | Descrição | Entidade | Usado | Sim | Obrigatório | Não | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Indica a Entidade do Documento. |
Campo | DMS_INDENT | Tipo | Caractere | Tamanho | 1 | Decimal | 0 | Formato | @! | Título | Indice Entid. | Descrição | Indice Entidade | Usado | Sim | Obrigatório | Não | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Indica o Indice da Entidade a ser utilizado para a pesquisa da Chave da Entidade |
Campo | DMS_CHVENT | Tipo | Caractere | Tamanho | 200 | Decimal | 0 | Formato | @! | Título | Chave Entid. | Descrição | Chave Entidade | Usado | Sim | Obrigatório | Não | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Chave que contem os dados do Documento integrados ao Planejamento de Rotas (TPR) |
Campo | DMS_INDEXT | Tipo | Caractere | Tamanho | 1 | Decimal | 0 | Formato | @! | Título | Ind.Chv.Ext | Descrição | Indice Chave Externa | Usado | Sim | Obrigatório | Não | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Indica o Indice da Entidade a ser utilizado para a pesquisa da Chave Externa |
Campo | DMS_ENTEXT | Tipo | Caractere | Tamanho | 3 | Decimal | 0 | Formato | @! | Título | Ent.Chv.Ext | Descrição | Entidade Chave Externa | Usado | Sim | Obrigatório | Não | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Indica a Entidade da Chave Externa |
Campo | DMS_CHVEXT | Tipo | Caractere | Tamanho | 30 | Decimal | 0 | Formato | @! | Título | Chv. Externa | Descrição | Chave Externa | Usado | Sim | Obrigatório | Não | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Identifica o registro gerado na Integração Protheus x Planejamento de Rotas (TPR) Exemplo: Módulo SIGATMS, caso a integração tenha sido realizada pela rotina de Programação de Carregamento, neste campo irá constar o Nro da Programação que o Documento foi vinculado. (Filial + Fil.Prog + Nro Prog + Seq.Prog) |
Campo | DMS_STATUS | Tipo | Caractere | Tamanho | 1 | Decimal | 0 | Formato | @! | Título | Status | Descrição | Status | Usado | Sim | Obrigatório | Sim | Browse | Não | Opções | 1=Pendente;2=Rejeitado;3=Processado;4=Falha no Processamento | When |
| Relação | '1' | Val. Sistema | Pertence("12345") | Help | Identifica o status do Documento para Roteirização 1-Pendente - Enviado para o TPR e aguardando retorno. 2-Rejeitado - Documento rejeitado pelo TPR. 3-Processado - Documento processado no TPR com sucesso.
4- Falha no Processamento - Ocorreu uma falha de processamento do Documento no Protheus.
5- Cancelado
|
Campo | DMS_MSGERR | Tipo | Memo | Tamanho | 50 | Decimal | 0 | Formato |
| Título | Msg. Erro | Descrição | Mensagem Erro | Usado | Sim | Obrigatório |
| Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Mensagem de erro recebida pelo Roteirizador do referido documento |
Tabela DA3 - Veículos ** O campo abaixo consta no pacote de dicionários 009560 - SIGAOMSCampo | DA3_VELOC | Tipo | Numérico | Tamanho | 6 | Decimal | 0 | Formato | @E 999,999 | Título | Veloc Máxima | Descrição | Velocidade Máxima | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Informar a velocidade máxima que o veículo pode percorrer |
|
Criação de índices: DMR Índice | Ordem | Chave | Descrição | DMR | 1 | DMR_FILIAL+DMR_FILROT+DMR_IDROT | Fil.Roteir. + Id.Roteir. |
DMS Índice | Ordem | Chave | Descrição | DMS | 1 | DMS_FILIAL+DMS_FILROT+DMS_IDROT+DMS_ITEM | Fil.Roteir. + Id.Roteir. + Item | DMS | 2 | DMS_FILIAL+DMS_ENTIDA+DMS_CHVENT+DMS_STATUS+DMS_FILROT+DMS_IDROT | Entidade + Chave Entid + Status + Fil.Roteir. + Id.Roteir. | DMS | 3 | DMS_FILIAL+DMS_ENTEXT+DMS_CHVEXT | Ent.Chv.Ext + Chave Externa | DMS | 4 | DMS_FILIAL+DMS_FILROT+DMS_IDROT+DMS_CHVENT+DMS_ENTIDA | Fil.Roteir. + Id.Roteir. + Chave Entid + Entidade |
|
|
---------------------------------------------------
Tabela | Descrição | DND | Config. Integração Portal Logistico |
|
Índice | Ordem | Chave | Descrição | DND | 1 | DND_FILIAL+DND_CODCON+DND_SEQUEN | Config. Integração Portal Logistico |
|
Campo | DND_FILIAL | Tipo | Caractere | Tamanho | 2 | Decimal | 0 | Formato |
| Título | Filial | Descrição | Filial do Sistema | Usado | Não | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help |
|
Campo | DND_CODCON | Tipo | Caractere | Tamanho | 4 | Decimal | 0 | Formato | @! | Título | Cod Config | Descrição | Código da Configuração | Usado | Não | Obrigatório | Não | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Este campo armazena o código que representará a configuração de integração com o Portal Logístico |
Campo | DND_SEQUEN | Tipo | Caractere | Tamanho | 6 | Decimal | 0 | Formato | @! | Título | Sequência | Descrição | Sequência | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Este campo armazena o numero sequencial para identificar a configuração de integração com o Portal Logística |
Campo | DND_ID | Tipo | Caractere | Tamanho | 30 | Decimal | 0 | Formato |
| Título | Client ID | Descrição | Client ID | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Este campo armazenará o Client_ID parâmetro utilizado para realizar a conexão com o Portal Logistico |
Campo | DND_SECRET | Tipo | Caractere | Tamanho | 20 | Decimal | 0 | Formato | @* | Título | Client Secret | Descrição | Client Secret | Usado | Sim | Obrigatório | Não | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Este campo armazenará o CLIENT_ID, parâmetro utilizado para realizar a conexão com o Portal Logístico. |
Campo | DND_TENANT | Tipo | Caractere | Tamanho | 40 | Decimal | 0 | Formato |
| Título | Tenant | Descrição | Tenant | Usado | Sim | Obrigatório | Não | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Este campo armazena o TENANT, parametro utilizado para configuração de integração com o Portal Logística. |
Campo | DND_URLTOK | Tipo | Caractere | Tamanho | 80 | Decimal | 0 | Formato |
| Título | URL Token | Descrição | URL do Token | Usado | Sim | Obrigatório | Não | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Este campo armazena a URL responsável por obter o Token de acesso ao Portal Logístico. |
Campo | DND_URLAPP | Tipo | Caractere | Tamanho | 80 | Decimal | 0 | Formato |
| Título | URL Port.Log. | Descrição | URL Portal Logístico | Usado | Sim | Obrigatório | Não | Browse | Sim | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Este campo armazena a URL de acesso ao Portal Logistica. |
Campo | DND_USER | Tipo | Caractere | Tamanho | 60 | Decimal | 0 | Formato |
| Título | Usuário | Descrição | Usuário | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Este campo deve armazenar o usuário que possui acesso ao Portal Logístico. |
Campo | DND_PASSW | Tipo | Caractere | Tamanho | 30 | Decimal | 0 | Formato | @* | Título | Senha | Descrição | Senha | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Este campo deve armazenar a senha de acesso ao Portal Logistico |
Campo | DND_TOKEN | Tipo | MEMO | Tamanho | 50 | Decimal | 0 | Formato |
| Título | Senha | Descrição | Senha | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Este campo armazenará o token disponibilizado quando a configuração do Portal Logistico for executada com sucesso. |
Campo | DND_DTTOKE | Tipo | Data | Tamanho | 8 | Decimal | 0 | Formato |
| Título |
| Descrição |
| Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Data em que o Token foi obtido. |
Campo | DND_HRTOKE | Tipo | Caractere | Tamanho | 13 | Decimal | 0 | Formato | 99:99:99 | Título | Hora Token | Descrição | Hora do Token | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Hora em que o Token foi obtido. |
Campo | DND_EXPIRE | Tipo | Numérico | Tamanho | 6 | Decimal | 0 | Formato | @E 999,999 | Título | Mom.Quit.Rep | Descrição | Momento Quitação Repom | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema |
| Help | Tempo de validade do Token. |
Campo | DND_MSBLQL | Tipo | Caractere | Tamanho | 15 | Decimal | 0 | Formato | @! | Título | Bloqueado? | Descrição | Bloqueado? | Usado | Sim | Obrigatório | Não | Browse | Não | Opções | 1=Sim;2=Não | When |
| Relação | "2" | Val. Sistema | Pertence('12') | Help | Este campo indica se o registro está bloqueado ou não |
Campo | DND_CODFON | Tipo | Caractere | Tamanho | 2 | Decimal | 0 | Formato | @! | Título | Cod Fonte | Descrição | Código da Fonte | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação | "0" | Val. Sistema | ExistCpo("DN6",M->DND_CODFON) | Help | Este campo armazena o código da Fonte que este registro utiliza para realizar integração com o Portal Logistico. |
Campo | DND_DESFON | Tipo | Caractere | Tamanho | 30 | Decimal | 0 | Formato | @! | Título | Descr Fonte | Descrição | Descrição da Fonte | Usado | Sim | Obrigatório | Não | Browse | Não | Opções |
| When |
| Relação |
| Val. Sistema | IIF(INCLUI,"",POSICIONE("DN6",1,XFILIAL("DN6") + DND->DND_CODFON,"DN6_DESCRI")) | Help | Descrição da Fonte |
|
|
05. DEMAIS INFORMAÇÕES
06. ASSUNTOS RELACIONADOS
