Histórico da Página

...

A especificação técnica do DTF nos trouxe três serviços disponibilizados pela API:

1. File Upload: subida de um arquivo específico gerado pelo Protheus para o DTF;

2. File List: listagem dos arquivos disponíveis para serem baixados do DTF para o Protheus;

3. File Download: baixa de um arquivo específico gerado pelo DTF para o Protheus.

...

Desta forma, foram disponibilizados os processos de download e upload que deverão ser tratados da seguinte forma:

1. Download:

a. O sistema realiza a listagem dos arquivos disponíveis para o download através do serviço File List;

b. Uma vez em posse dos nomes dos arquivos a serem baixados, uma fila deverá ser criada para que os arquivos sejam baixados;

c. Por fim, será realizada a chamada do serviço File Download para cada arquivo da fila.

2. Upload:

a. O sistema realiza a leitura de todos os arquivos existentes nos diretórios de upload configurados (a ideia é ter diretórios segmentados por processo);

b. Uma vez em posse dos nomes dos arquivos a serem subidos, uma fila deverá ser criada para que os arquivos sejam subidos;

c. Por fim, será realizada a chamada do serviço File Upload para cada arquivo da fila.

Procedimentos para utilização

Totvs custom tabs box

tabs	Atualização De Dicionário, Passo 01, Passo 02, Passo 03, Passo 04
ids	AtualizaçãoDeDicionário,passo1,passo2

Totvs custom tabs box items

default	yes
referencia	AtualizaçãoDeDicionário

ATENÇÃO! Como se trata tratam de uma rotina de configuração técnica 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

(SIGAOFI)

/ Auto-Peças / Veículos conforme instruções a seguir:

Menu	Atualizações
Submenu	Geral John Deere
Nome da Rotina	Configura diretórios DTF API
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 REST
Programa	OFIA411
Módulo	Oficina / Auto-Peças / Veículos
Tipo	Função Protheus

Menu	Consultas
Submenu	Gerais
Nome da Rotina	Log API
Programa	OFIA262
Módulo	Oficina / Auto-Peças / Veículos
Tipo	Função Protheus

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_UUID	VK5_DATTYP
Tipo	Caracter	Caracter	Caracter
Grupo de Campos	033
Ordem	01	02	03
Tamanho	2	36	2
Decimal	0	0	0
Formato	@!	@!	@!
Contexto	1 - Real	1 - Real	1 - Real
Propriedade	1 - Alterar	1 - Alterar	1 - Alterar
Título	Filial	UUID	Tipo de dado
Descrição	Filial	Unique ID	Tipo de dados
Val. Sistema			Vazio() .or. ExistCPO("VX5","084"+M->VK5_DATTYP)
Opções			#OFIOA560CB("084",2)
Inic. Padrão	xFilial("VK5")	FWUUIDV4(.t.)	"01"
Inic. Browse
Cons. Padrão
Nível	1	1	1
Usado	Não	Sim	Sim
Obrigatório	Não	Não	Sim
Browse	Não	Não	Sim
When
Pasta
Help	Informe a Filial.	Unique ID.	Tipo para classificar por projeto os dados.

Campo	VK5_ORIGEM	VK5_MESSAG	VK5_ORITAB
Tipo	Caracter	Caracter	Caracter
Grupo de Campos
Ordem	04	05	06
Tamanho	2	2	3
Decimal	0	0	0
Formato	@!	@!	@!
Contexto	1 - Real	1 - Real	1 - Real
Propriedade	1 - Alterar	1 - Alterar	1 - Alterar
Título	Origem	Mensagem	Tabela Ori.
Descrição	Origem	Tipo de Mensagem	Tabela 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	1	1
Usado	Sim	Sim	Sim
Obrigatório	Sim	Não	Não
Browse	Sim	Sim	Sim
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_RESCOD	VK5_REQHEA
Tipo	Caracter	Numérico	Memo
Grupo de Campos
Ordem	07	08	09
Tamanho	100	3	10
Decimal	0	0	0
Formato	@!	@ 999	@!
Contexto	1 - Real	1 - Real	1 - Real
Propriedade	1 - Alterar	1 - Alterar	1 - Alterar
Título	Chave Ori.	Resp. HTTP	Req. Cab.
Descrição	Chave Registro de Origem	Resp. HTTP	Headers da Req.
Val. Sistema
Opções
Inic. Padrão
Inic. Browse
Cons. Padrão
Nível	1	1	1
Usado	Sim	Sim	Sim
Obrigatório	Não	Não	Não
Browse	Sim	Sim	Nã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_RESHEA	VK5_RESBOD
Tipo	Memo	Memo	Memo
Grupo de Campos
Ordem	10	11	12
Tamanho	10	10	10
Decimal	0	0	0
Formato	@!	@!	@!
Contexto	1 - Real	1 - Real	1 - Real
Propriedade	1 - Alterar	1 - Alterar	1 - 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	1	1
Usado	Sim	Sim	Sim
Obrigatório	Não	Não	Não
Browse	Não	Não	Nã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
Contexto	1 - Real	1 - Real
Propriedade	1 - Alterar	1 - 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ão	FGX_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

default	no
referencia	passo1

1 - Verifique se o parâmetro MV_MIL0005 está configurado corretamente para cada filial do sistema.
1 - Acesse o Protheus com um usuário configurado com permissão / perfil de administrador.

2 - 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

default	no
referencia	passo2

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. Clique em Confirmar para salvar a alteração;

d. Saia/Feche o Protheus;

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

6 - As integrações da John Deere com o concessionário que foram afetadas no Protheus estão listadas abaixo:

a. Aba Garantia: Solic. Garantia JD (OFINJD15) / Cons. Garantia JD (OFICJD01) / Atualiza Status SG (OFINJD26);

b. Aba JDPoint: Pedido de Peças JD (OFINJD10);

c. Aba JDQuote2: Cotações JDQuote (VEIA110) / PO JDQuote (VEIA112) / Importação de Cotações (VEIA113) / Painel JDQuote (VEIA114);

d. Aba Nota Fiscal de Compra: Relac. NF x Pedido (OFINJD22).

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

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

7 - Além do campo oAuth2, todas as outras abas possuem o mesmo padrão de campos que remetem a informações necessárias para utilização do oAuth2.0/OKTA, cujos campos estarão preenchidos automaticamente, dispensando qualquer alteração/atualização de seus conteúdos. A saber:

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

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

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

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

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

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

default	no
referencia	passo3

Configuração do Diretórios:

1 - Acesse a rotina Atualizações\Geral John Deere\Configura diretórios DTF API (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. SetHost - Endereço do host da API DTF

b. CGPoll - "RECEIPTS_"

c. Cotacao_Maquina - "DLR2JD_*.JDQUOTE"

d. PMMANAGE - "DLR2JD_*.DAT"

e. DPMEXT - "DLR2JD_DPMEXT*.DPM"

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

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

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. Clique em Confirmar para salvar a alteração;

b. Saia/Feche o Protheus;

Totvs custom tabs box items

default	no
referencia	passo4

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. OFIA411 – DTF API REST: inclua este novo agendamento conforme abaixo:

i. Usuário: 000000 (Administrador);
ii. Rotina: OFIA411;
iii. Empresa/Filial: selecione a Empresa e suas filiais;
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

default	no
referencia	passo5

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 arquvivos)

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 REST (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 REST (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)

Totvs custom tabs box items

default	no
referencia	passo6

Consulta Status das APIs e chamadas pontuais:

Criada rotina DTF API REST (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

default	no
referencia	passo7

Consulta de Logs:

Disponibilizada na rotina Consulta de Logs(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 Code*	HTTP Status & Code	*Message*

FileAttachmentMissing	Bad Request (400)	File Attachment not found
Not Found	Not Found(404)	No message available
DealerPathNotFound	Not Found (404)	The specified dealer path doesn't exist: [Parent id]
FileAlreadyExists	Conflict (409)	The specified file already exists
insufficient_scope	Forbidden (403)	Insufficient scope for this resource
FileIOException	Internal 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 message	200 (OK)
DealerSetupNot Found	Not Found (404)	Dealer setup does not exist.
insufficient_scope	Forbidden (403)	Insufficient scope for this resource
ServiceUnavaila ble	Internal Server Error (500)	Unable to process your request.
FileNotFound	Not Found (404)	Specified File does not exist.
NotReadble	Forbidden (403)	Unable to read the file.
insufficient_scope	Forbidden (403)	Insufficient scope for this resource
ServiceUnavailable	Internal Server Error (500)	Unable to process your request

04. DEMAIS INFORMAÇÕES

Card documentos

Informacao	Use esse box para destacar informações relevantes e/ou de destaque.
Titulo	IMPORTANTE!

...

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

Procedimentos para utilização

04. DEMAIS INFORMAÇÕES