Árvore de páginas

Versões comparadas

Chave

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

...

Totvs custom tabs box
tabsAtualização de Dicionário, Configurações Iniciais, Configurações do Autenticador, Configuração de Diretórios, Agendamento de Execução Automática, Envio e Recebimento de Arquivo, Consulta Status, Consulta Logs, Arquivos e processos de integração contemplados pelo DTF
idsAtualizaçãoDeDicionário,ConfiguraçõesIniciais,ConfiguraçõesdoAutenticador,ConfiguraçãoDeDiretórios,AgendamentoExecuçãoAutomática,EnvioERecebimentoDeArquivo,ConsultaStatus,ConsultaLogs,ArqProcIntegraçãoDTF
Totvs custom tabs box items
defaultyes
referenciaAtualizaçãoDeDicionário

ATENÇÃO! Como se tratam de rotinas de configurações técnicas do sistema, não insira estas rotinas em menus de usuários. Somente a equipe de T.I. deve ter acesso a estas rotinas!



  • No Configurador (SIGACFG) acesse Ambientes/Cadastros/Menu (CFGX013). Informe as novas opções de menu do módulo de Oficina / Auto-Peças / Veículos conforme instruções a seguir:



Menu

Atualizações

Submenu

Geral John Deere

Nome da Rotina

Diretórios DTF API John Deere

Programa

OFIA410

Módulo

Oficina / Auto-Peças / Veículos

Tipo

Função Protheus



Menu

Atualizações

Submenu

Geral John Deere

Nome da Rotina

DTF API John Deere

Programa

OFIA411

Módulo

Oficina / Auto-Peças / Veículos

Tipo

Função Protheus



Menu

Atualizações

Submenu

Geral John Deere

Nome da Rotina

Log DTF API John Deere

Programa

OFIA262

Módulo

Oficina / Auto-Peças / Veículos

Tipo

Função Protheus




Os dicionários abaixo, serão criados automaticamente durante a execução do diferencial abaixo:

Pacotes Gerados:

12.1.25: https://r.totvs.io/p/1048325

12.1.27: https://r.totvs.io/p/1048326

12.1.33: https://r.totvs.io/p/1048327

Diferencial (UPDDISTR):O link a seguir, se aplica a todas as releases da versão 12 do Protheus: https://suporte.totvs.com/portal/p/10098/download?e=1048431




Criação de Tabela no arquivo SX2 – Tabelas:


Chave

Nome

Modo

PYME

VK5

Log de Requisições WEB

E

S




Criação de Campo no arquivo SX3 – Campos:


  • Tabela VK5 - Log de Requisições WEB:


Campo

VK5_FILIAL

VK5_UUIDVK5_DATTYP
Tipo

Caracter

CaracterCaracter
Grupo de Campos033

Ordem

01

0203
Tamanho

2

362
Decimal

0

00
Formato@!@!@!
Contexto1 - Real1 - Real1 - Real
Propriedade1 - Alterar1 - Alterar1 - Alterar
Título

Filial

UUIDTipo de dado
Descrição

Filial

Unique IDTipo de dados
Val. Sistema



Vazio() .or. ExistCPO("VX5","084"+M->VK5_DATTYP)
Opções

#OFIOA560CB("084",2)
Inic. PadrãoxFilial("VK5")

FWUUIDV4(.t.)

"01"
Inic. Browse


Cons. Padrão




Nível

1

11
Usado

Não

SimSim
Obrigatório

Não

NãoSim
Browse

Não

NãoSim
When




Pasta




Help

Informe a Filial.

Unique ID.

Tipo para classificar por projeto os dados.



Campo

VK5_ORIGEM

VK5_MESSAGVK5_ORITAB
Tipo

Caracter

CaracterCaracter
Grupo de Campos


Ordem

04

0506
Tamanho

2

23
Decimal

0

00
Formato@!@!@!
Contexto1 - Real1 - Real1 - Real
Propriedade1 - Alterar1 - Alterar1 - Alterar
Título

Origem

MensagemTabela Ori.
Descrição

Origem

Tipo de MensagemTabela de Origem
Val. Sistema

Vazio() .or. ExistCPO("VX5","085"+M->VK5_ORIGEM)

Vazio() .or. ExistCPO("VX5","083"+M->VK5_MESSAG)
Opções#OFIOA560CB("085",2)#OFIOA560CB("083",2)
Inic. Padrão"01"



Inic. Browse


Cons. Padrão




Nível

1

11
Usado

Sim

SimSim
Obrigatório

Sim

NãoNão
Browse

Sim

SimSim
When




Pasta




Help

Origem da requisição, se veio do SO, mobile ou protheus (DBS).

Informe o tipo de mensagem.

Informa a tabela de origem do registro.



Campo

VK5_ORIKEY

VK5_RESCODVK5_REQHEA
Tipo

Caracter

NuméricoMemo
Grupo de Campos


Ordem

07

0809
Tamanho

100

310
Decimal

0

00
Formato@!@E 999@!
Contexto1 - Real1 - Real1 - Real
Propriedade1 - Alterar1 - Alterar1 - Alterar
Título

Chave Ori.

Resp. HTTPReq. Cab.
Descrição

Chave Registro de Origem

Resp. HTTPHeaders da Req.
Val. Sistema




Opções


Inic. Padrão



Inic. Browse


Cons. Padrão




Nível

1

11
Usado

Sim

SimSim
Obrigatório

Não

NãoNão
Browse

Sim

SimNão
When




Pasta




Help

Informa a chave de pesquisa do registro da tabela de origem.

Informe o código do retorno HTTP.

Headers da requisicao em formato json



Campo

VK5_REQBOD

VK5_RESHEAVK5_RESBOD
Tipo

Memo

MemoMemo
Grupo de Campos


Ordem

10

1112
Tamanho

10

1010
Decimal

0

00
Formato@!@!@!
Contexto1 - Real1 - Real1 - Real
Propriedade1 - Alterar1 - Alterar1 - Alterar
Título

Req. Body

Resp. Cab.Resp. Body
Descrição

Body da Req.

Headers da Resp.Body da Resp.
Val. Sistema




Opções


Inic. Padrão



Inic. Browse


Cons. Padrão




Nível

1

11
Usado

Sim

SimSim
Obrigatório

Não

NãoNão
Browse

Não

NãoNão
When




Pasta




Help

Body da requisicao em formato json

Headers da resposta em formato json

Body da resposta em formato json



Campo

VK5_DATINC

VK5_DATALT
Tipo

Caracter

Caracter
Grupo de Campos

Ordem

13

14
Tamanho

14

14
Decimal

0

2
Formato@R 9999-99-99 99:99:99@E 99,999,999,999.99
Contexto1 - Real1 - Real
Propriedade1 - Alterar1 - Alterar
Título

Dt Inclusão

Dt Alteração
Descrição

Data Inclusão Registro

Data Alteração Registro
Val. Sistema



Opções

Inic. PadrãoFGX_Timestamp()

FGX_Timestamp()

Inic. Browse

Cons. Padrão



Nível

1

1
Usado

Sim

Sim
Obrigatório

Não

Não
Browse

Sim

Sim
When

.f.

.f.
Pasta



Help

Data em que o registro foi inserido no banco.

Data em que o registro foi alterado no banco.




Criação de Índices no arquivo SIX – Índices:



  • Tabela VCU - Histórico DEF por Campo DEF:


Índice

VK5

Ordem

1

Chave

VK5_FILIAL+VK5_UUID

Descrição

Unique id

Proprietário

S



Índice

VK5

Ordem

2

Chave

VK5_FILIAL+VK5_DATTYP+VK5_ORIGEM

Descrição

Tipo de dados + Origem

Proprietário

S



Índice

VK5

Ordem

3

Chave

VK5_FILIAL+VK5_DATINC

Descrição

Data Inclusão

Proprietário

S



Índice

VK5

Ordem

4

Chave

VK5_FILIAL+VK5_DATALT

Descrição

Data Alteração

Proprietário

S



Índice

VK5

Ordem

5

Chave

VK5_FILIAL+VK5_ORITAB+VK5_ORIKEY

Descrição

Tabela Ori.+Chave Ori.

Proprietário

S

Totvs custom tabs box items
defaultno
referenciaConfiguraçõesIniciais

1 - Verifique se o parâmetro MV_MIL0005 está configurado corretamente para cada filial do sistema.


2 - Configure o MaxStringSize no appserver.ini

MaxStringSize - TOTVSTEC - TDN - Configuração Indicada:


[general]

maxStringSize=500


3 - Configure o MemoMega no appserver.ini

MemoMega - TOTVSTEC - TDN - Configuração Indicada:


[DBAccess]

MemoMega=100


4 - Acesse o Protheus com um usuário configurado com permissão / perfil de administrador.


5 - No Modulo Veículos (SIGAVEI) acesse Atualizações\Cad Gerais\Tab. Gener. Conces. (OFIOA560) para que os novos registros padrão da tabela VX5 sejam criados.

Totvs custom tabs box items
defaultno
referenciaConfiguraçõesdoAutenticador

Configuração do Autenticador


1 - Acesse a rotina Atualizações\Geral John Deere\Autent. WebService JD OKTA (OFIA280).


2 - Será exibida a janela para configuração do autenticador.


3 - Na aba denominada Geral serão informados os dados das credenciais de autenticação enviados pela John Deere para cada concessionário. Desta forma, os campos Client ID, Client Secret e Redirect URI deverão ser passados pela John Deere ao concessionário, conforme explicado no passo 1 da seção Parametrizações. Com as informações disponibilizadas pela John Deere em mãos, preencha os campos desta aba. Após cadastrar estas informações, clique em Confirmar para salvar.


4 - Todas as outras abas correspondem as integrações específicas da John Deere. Vale ressaltar que para ligar e desligar o oAuth2.0/OKTA, cada integração possui um campo denominado oAuth2 que possui as opções 0=Não e 1=Sim. Como padrão, todas as integrações virão desligadas (0=Não).


5 - Para realizar a mudança de forma de autenticação para o OKTA, basta:

a. Acesse a aba correspondente a integração desejada;

b. Preencha o campo oAuth2 com 1=Sim;

c. Aba DTFGETAPI: Configurações para conseguir o Token para efetuar GET na API.

i. URL Token: o endereço URL onde será obtido o token de autenticação;

preencher com: https://sso.johndeere.com

ii. Auth Server: o nome do servidor de autenticação para cada integração específica;

preencher com: aus9k0fb8kUjG8S5Z1t7

iii. URL Auth: o endereço URL do servidor de autenticação;

preencher com: /v1/token

iv. Escopo: o escopo de conexão definido para cada integração específica;

preencher com: dtf:dbs:file:read

v. URL WS: endereço URL do webservice para cada integração específica

preencher com: https://servicesext.deere.com/dtfapi/

d. Aba DTFPUTAPI: Configurações para conseguir o Token para efetuar PUT na API.

i. URL Token: o endereço URL onde será obtido o token de autenticação;

preencher com: https://sso.johndeere.com

ii. Auth Server: o nome do servidor de autenticação para cada integração específica;

preencher com: aus9k0fb8kUjG8S5Z1t7

iii. URL Auth: o endereço URL do servidor de autenticação;

preencher com: /v1/token

iv. Escopo: o escopo de conexão definido para cada integração específica;

preencher com: dtf:dbs:file:write

v. URL WS: endereço URL do webservice para cada integração específica

preencher com: https://servicesext.deere.com/dtfapi/

e. Clique em Confirmar para salvar a alteração;

f. Saia/Feche o Protheus;

g. Acesse o Protheus novamente para integrar utilizando oAuth2.0/OKTA.



IMPORTANTE: Para mais informações referentes ao OKTA, acesse o link: https://tdn.totvs.com.br/pages/releaseview.action?pageId=553893397






Totvs custom tabs box items
defaultno
referenciaConfiguraçãoDeDiretórios

Configuração do Diretórios


1 - Acesse a rotina Atualizações\Geral John Deere\Diretórios DTF API John Deere (OFIA410).


2 - Será exibida a janela para configuração dos diretórios.


3 - Estes diretórios serão utilizados para o recebimento e envio dos arquivos contemplados pelo DTF. Teremos pastas específicas para cada um dos tipos de arquivos contemplados. Abaixo assuntos e tipos de arquivos interpretados.

a. CGPoll - "RECEIPTS_"

b. Cotacao_Maquina - "DLR2JD_*.JDQUOTE"

c. PMMANAGE - "DLR2JD_*.DAT"

d. DPMEXT - "DLR2JD_DPMEXT*.DPM"

e. Warranty - "JD2DLR_*_WARRMEMO_*.XML"

f. Incentivo_Maquina - "*.BRCMAMT" e "*.BRSLERR"

g. UP_Incentivo_Maquina - "*.BRSLDAT" e "*.BRCMDAT"

h. JDPRISM - "JD2DLR_DPMORD_*.DAT", "JD2DLR_DPMSCHED_*.DAT" e "JD2DLR_DPMXFER_*.DAT"

i. Parts_Info - "PARTINFO_BR_ALL_FULL_V2_*.DAT"

j. Parts_Locator - "DLR2JD_*.DAT"

k. Authorized_Parts_Returns - "*RETATH*.XML"

l. Parts_Surplus_Returns - "DLR2JD_*.DAT"

m. Parts_Subs - Parts Subs - "PARTSUBS_NA_ALL_FULL_*.DAT"

n. SMManage - SMManage - "DLR2JD_*.DAT"

o. DFA - "Definido pelo usuário"

p. ELIPS - "DLR2JD_ELIPS_Hist_*.XML" e "DLR2JD_ELIPS_Delta_*.XML"

q. NAO_CLASSIFICADOS - Para recebimento de arquivos não catalogados.


4 - Estes diretórios e o endereço do Host estarão preenchidos automaticamente, dispensando qualquer alteração/atualização de seus conteúdos.

a. Acesse o RootPath onde do Protheus e verifique se já existe o diretório "\DTF".

i. Caso já exista, renomeie o diretório para "\DTF_SALVA".

ii. Caso não exista, ele será criado automaticamente.

b. Clique em Confirmar para criar os diretórios;

i. Os diretórios serão criados conforme a descrição dos campos da rotina.

ii. Dentro de cada um, será criada um diretório com o numero dos Dealers.

Ex: \DTF\COTACAO_MAQUIA\201010\

c. Saia/Feche o Protheus;


Totvs custom tabs box items
defaultno
referenciaAgendamentoExecuçãoAutomática

Agendamento de Execução Automática


1. No Configurador (SIGACFG), acesse Ambiente\ Schedule\ Schedule (CFGA010).


2. Aqui deverão ser atualizados os seguintes agendamentos referentes a processos para execução automática:

a. DTF API John Deere - OFIA411: inclua este novo agendamento conforme abaixo:

i. Usuário: 000000 (Administrador);

ii. Rotina: OFIA411;

iii. Empresa/Filial: selecione apenas a Empresa e suas filiaisMatriz;

iv. Módulo: 41 (Auto- Peças);

v. Recorrência: ao clicar neste botão, selecione a opção Sempre ativo.


Totvs custom tabs box items
defaultno
referenciaEnvioERecebimentoDeArquivo

Chamadas Pontuais para envio e recebimento de arquivos


Foram disponibilizadas rotinas para efetuar a chamada pontual da API, tanto para envio quanto para recebimento de arquivos.

1 - Download(recebimento de arquivos)

a - Painel Pedidos Imp. CGPoll JD (VEIA160)

i. CGPoll(RECEIPTS_*.DAT)


b - Solicitação de Garantia ( OFINJD15 )

i . Garantia(JD2DLR_*_WARRMEMO_*.XML).


c - Trans/Recep de NFs (VEIVM200)

i. Incentivos Máquinas(*.BRCMAMT)

ii. Incentivos Máquinas(*.BRSLERR)


d - Config JDPrism DPM (OFINJD35)

i. JDPRISM(DPMORD)

ii. JDPRISM(DPMSCHED)

iii. JDPRISM(DPMXFER)


e - DTF API John Deere (OFIA411)

i. Lista Preço Peças(PARTINFO_BR_ALL_FULL_V2_*.DAT)

ii. Recompra de Peças(*RETATH*.XML)

iii. Substituição Peças(PARTSUBS_NA_ALL_FULL_*.DAT)


2 - Upload(envio de arquivos)

a - DTF API John Deere (OFIA411)

i. Cotação Máquinas(DLR2JD_*.JDQUOTE)

ii. Localizador Peças(DLR2JD_*.DAT)

iii. Recompra de Peças(DLR2JD_*.DAT)

iv. SMManage(DLR2JD_*.DAT)

v. DFA(Definido pelo usuário)

vi. ELIPS(DLR2JD_ELIPS_Hist_*.XML)

vii. ELIPS(DLR2JD_ELIPS_Delta_*.XML)


b - Config JDPrism DPM (OFINJD35)

i. DPM PMMANAGE(DLR2JD_*.DAT)

ii. DPM DPMEXT(DLR2JD_DPMEXT*.DPM)


c - Trans/Recep de NFs (VEIVM200)

i. Inventivos Máquinas(*.BRSLDAT)

ii. Inventivos Máquinas(*.BRCMDAT)




Totvs custom tabs box items
defaultno
referenciaConsultaStatus

Consulta Status das APIs e chamadas pontuais


Criada rotina DTF API John Deere (OFIA411). Nesta, é possível acompanhar o status dos serviços da API do DTF.

Também é possível fazer a chamada pontual de todos as integrações disponíveis via DTF.

O botão "TODOS" efetua a chamada em batch de todos os assuntos.

Totvs custom tabs box items
defaultno
referenciaConsultaLogs

Consulta de Logs


Disponibilizada na rotina Log DTF API John Deere (OFIA262).

Nesta é possível visualizar de forma simples os logs oriundos das chamadas ao DTF.


Disponibilizado filtro para listar os Logs da API DTF.


FileUpload:


Req. Cab.

Contem o token de autorização do OKTA.

Req. Body.

Contem o caminho completo do arquivo transmitido.

Resp. Cab.

Conteúdo do arquivo transmitido.

Resp. Body.

Contem a resposta da API.

No caso de erro, aqui é gravado o tipo e solução sugerida.



FileList:


Req. Cab.

Contem o token de autorização do OKTA.

Req. Body.

nil

Resp. Cab.

Contem a resposta da API.

Resp. Body.

Conteúdo do arquivo Json, que possui a lista de arquivos disponibilizados para Download.

No caso de erro, aqui é gravado o tipo e solução sugerida.



FileList:


Req. Cab.

Contem o token de autorização do OKTA.

Req. Body.

Caminho e nome do arquivo baixado.

Resp. Cab.

Contem a resposta da API.

Resp. Body.

Conteúdo do arquivo baixado.

No caso de erro, aqui é gravado o tipo e solução sugerida.


OBS: Tamanho do arquivo restrito ao máximo de um campo Memo.





Lista de erros:


Error CodeHTTP Status & CodeMessage



FileAttachmentMissingBad Request (400)File Attachment not found
Not FoundNot Found(404)No message available
DealerPathNotFoundNot Found (404)The specified dealer path doesn't exist: [Parent id]
FileAlreadyExistsConflict (409)The specified file already exists
insufficient_scopeForbidden (403)Insufficient scope for this resource
FileIOExceptionInternal Server Error (500)The specified file not able to write to the specified resource path
In case of no file found, we return 200 (OK) with empty message200 (OK)
DealerSetupNot FoundNot Found (404)Dealer setup does not exist.
insufficient_scopeForbidden (403)Insufficient scope for this resource
ServiceUnavaila bleInternal Server Error (500)Unable to process your request.
FileNotFoundNot Found (404)Specified File does not exist.
NotReadbleForbidden (403)Unable to read the file.
insufficient_scopeForbidden (403)Insufficient scope for this resource
ServiceUnavailableInternal Server Error (500)Unable to process your request
Totvs custom tabs box items
defaultno
referenciaArqProcIntegraçãoDTF

Arquivos e processos de integração contemplados pelo DTF



MáquinasProcessoChamada/FunçãoDown/UpDescrição ArquivoArquivo
MáquinasCGPollVEIA160DownloadListagem de pedidos de compra de máquinas do Configurador da John Deere.RECEIPTS_04Jun2019_000615.DAT
MáquinasCotação MáquinasOFIA411UploadMachine Finder Pro - informações de máquinas John Deere novas e usadas, bem como máquinas usadas de outras marcas, para serem vendidas.DLR2JD_*.JDQUOTE
PeçasDPMOFINJD35UploadPMMANAGE (PMM)DLR2JD_*.DAT
PeçasDPMOFINJD35UploadDPMEXT (Parts Data)DLR2JD_DPMEXT*.DPM
OficinaGarantiaOFINJD15DownloadWarranty Memo - Retorno da John Deere aprovando ou rejeitando a garantia enviada.

JD2DLR_*_WARRMEMO_*.XML

MáquinasIncentivos MáquinasVEIVM200UploadArquivo contendo notas fiscais e valor que deverá ser gerada a nota fiscal de bônus.*.BRCMDAT
MáquinasIncentivos MáquinasVEIVM200UploadArquivo contendo notas fiscais e valor que deverá ser gerada a nota fiscal de venda.*.BRSLDAT
MáquinasIncentivos MáquinasVEIVM200DownloadArquivo contendo notas fiscais e valor que deverá ser gerada a nota fiscal de bônus.*.BRCMAMT
MáquinasIncentivos MáquinasVEIVM200DownloadArquivo com retorno negativo contendo notas fiscais, chassis, código e descrição do erro informando o motivo da negativação.*.BRSLERR
PeçasJDPRISMOFINJD35DownloadDPMORD (Order) - este arquivo contém as instruções para criação dos pedidos de compras no Protheus (peças e quantidades).JD2DLR_DPMORD_*.DAT
PeçasJDPRISMOFINJD35DownloadDPMSCHED (Management Data) - contém as instruções para a execução da geração do Parts Data.JD2DLR_DPMSCHED_*.DAT
PeçasJDPRISMOFINJD35DownloadDPMXFER (Transfers) - este arquivo contém as instruções para a criação dos orçamentos de transferência no Protheus (peças, quantidades e filiais).JD2DLR_DPMXFER_*.DAT
PeçasLista Preço PeçasOFIA411DownloadParts Info - Atualização do cadastro de peças da marca John Deere, como incluir novas peças, atualizar informações referentes a peça, bem como atualizar preços de Lista.PARTINFO_BR_ALL_FULL_V2_*.DAT
PeçasLocalizador PeçasOFIA411UploadParts Locator - processo de disponibilização de seu estoque disponível atual para compra entre os concessionários da rede John Deere.DLR2JD_*.DAT
PeçasRecompra de PeçasOFIA411DownloadAuthorized Parts Returns - processo de retorno da John Deere com as peças autorizadas para recompra.*RETATH*.XML
PeçasRecompra de PeçasOFIA411UploadParts Surplus Returns - processo de envio das peças desejadas para recompra do concessionário a John Deere.DLR2JD_*.DAT
OficinaSMManageOFIA411UploadSMManage - envio mensal do resumo da performance do departamento de Serviços do concessionário, por filial.DLR2JD_*.DAT
PeçasSubstituição PeçasOFIA411DownloadParts Subs - substituição automática de determinadas peças da marca John Deere.PARTSUBS_NA_ALL_FULL_*.DAT
ContabilidadeDFAOFIA411UploadDFA – Dealer Financial Analysis. O concessionário gerará seus valores contábeis para cada linha do plano de contas exigido pela John Deere, enviando um arquivo para envio a John Deere.Definido pelo usuário
OficinaELIPSOFIA411UploadEnvio a John Deere contendo dados de ordens de serviço e vendas de peças realizadas na modalidade Balcão (venda direta ao consumidor). Existem os formatos Init (carga inicial) e Delta (diário).DLR2JD_ELIPS_Hist_*.XML DLR2JD_ELIPS_Delta_*.XML

...