Árvore de páginas

Versões comparadas

Chave

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

Tempo aproximado para leitura: 02 min

01. DADOS GERAIS

Linha de Produto:Microsiga Protheus
Segmento:Varejo
Módulo:

Veículos (SIGAVEI)

Oficina (SIGAOFI)

Auto-Peças (SIGAPEC)

Função:

Autent. WebService JD OKTA (OFIA280)

Ticket:9221943
Requisito/Story/Issue (informe o requisito relacionado):MMIL-6082
Pacote(s) Gerado(s):

Liberação Pendente


02. SITUAÇÃO/REQUISITO

Existe a necessidade de que as integrações da John Deere com os concessionários façam uso do OKTA, visando o abandono da forma antiga de autenticação.

03. SOLUÇÃO

Implementada melhoria do autenticador de integrações WebServices da John Deere utilizando o protocolo oAuth 2.0, fazendo uso do sistema OKTA para realizar o serviço de gestão de credenciais da John Deere.

Abaixo, seguem as orientações de configuração e utilização das integrações desenvolvidas.



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

Chave

Nome

Modo

PYME

VRN

Configuracoes JSON

CS


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

Tabela VM0 - Cabec Conf NF EntradaVRN - Configuracoes JSON:

Campo

VRN_FILIAL

VRN_CODIGOVRN_CONFIG

Tipo

Caracter

CaracterMemo
Ordem010203

Tamanho

2

1010

Decimal

0

00

Formato

@!

@!


Contexto1 - Real1 - Real1 - Real
Propriedade1 - Alterar1 - Alterar1 - Alterar
Grupo de Campos033

Título

Filial

Codigo Configuracao

Descrição

Filial

CodigoConfiguracao

Opções




Inic. Padrão



Inic. Browse



Con. Padrão


Modo

C

CC

Val. Sistema




Nível

1

11

Usado

Não

SimSim

Obrigatório

Não

SimSim

Browse

Não

SimSim

When




Help

Informe a filial.

Informe o código da configuração.

Informe a configuração.



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

Índice

VM1

VRN

Ordem

1

Chave

VM1

VRN_FILIAL+

VM1_CODVM0+VM1_SEQUEN

VRN_CODIGO

Descrição

Codigo VM0 + Sequencial

Código

Proprietário

S


Introdução

Este documento visa definir e nortear todo o processo padrão das rotinas do sistema TOTVS Protheus para atualização e utilização do autenticador de integrações WebServices da John Deere utilizando o protocolo oAuth 2.0, fazendo uso do sistema OKTA para realizar o serviço de gestão de credenciais da John Deere. Desta forma, esta atualização permitirá que as integrações da John Deere com os concessionários façam uso do OKTA, visando o abandono da forma antiga de autenticação. A programação da John Deere é que esta nova forma de autenticação passe a ser utilizada a partir de 01/07/2020.


O que é oAuth 2.0?

OAuth 2 é um protocolo de autorização que permite que uma aplicação se autentique em outra. Para que isso aconteça, uma aplicação pede permissão de acesso para um usuário, sem que para isso ela tenha acesso a alguma senha dele. O usuário pode conceder ou não o acesso à aplicação. Depois da permissão ser aceita, caso o usuário precise alterar a senha de acesso, a permissão continuará válida para a aplicação e, caso necessário, a permissão dada à aplicação pode ser revogada a qualquer momento também.

Provavelmente você já clicou em algum botão escrito "Logar com sua conta do Google" ou "Logar com sua conta do Facebook" quando você está em alguma outra aplicação, para evitar de ter que fazer na mão algum cadastro. Neste caso, você está dando a autorização de uma aplicação terceira a usar os recursos da sua aplicação, neste caso o Google ou o Facebook. Essas aplicações têm acesso limitado às informações de usuários através do protocolo HTTP. OAuth 2 é utilizado nos mais diversos tipos de autenticação, como em telas de login e na autenticação de APIs (Application Programming Interface).

Desta forma, a partir deste momento, para que o Protheus realize uma comunicação com os sistemas da John Deere, será necessário utilizar este novo tipo de autenticação, bem como as credenciais cadastradas no OKTA da John Deere.



Parametrizações


1 - ATENÇÃO! Caso ainda não tenha feito, é necessário solicitar novas credenciais junto a John Deere via abertura de Incidente em https://johndeere.service-now.com/dp com o título: "Novas credenciais de integração". As credenciais são de uso exclusivo de cada Concessionário/Distribuidor, sendo totalmente responsável pela gestão e utilização delas. Caso precise de ajuda com este tópico, entre em contato com o Daniel Costa através do e-mail [email protected].



2 - No Configurador (SIGACFG) acesse Ambientes/Cadastro/Menu (CFGX013). Informe as novas opções de menu para o módulo que desejar, conforme instruções a seguir:

Menu

Atualizações

Submenu

Geral John Deere

Nome da Rotina

Autent. WebService JD OKTA

Programa

OFIA280

Módulo

Auto-Peças ou Oficina ou Veículos

Tipo

Função Protheus

TabelasVRN


ATENÇÃO! Como se trata de uma rotina de configuração técnica do sistema, não insira esta rotina em menus de usuários. Somente a equipe de T.I. deve ter acesso a esta rotina!


3 - Aplique o patch com a solução, bem como a atualização de dicionário diferencial referente a esta solução (UPDDISTR). Não se esqueça de realizar as diretrizes de segurança do Protheus (backups).



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. Sendo assim, preencha os campos desta aba conforme enviado pela John Deere. 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).


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.


8 - Para os casos de serem apresentados problemas no token armazenado automaticamente, foi disponibilizada uma funcionalidade para remoção do token obtido. Desta forma, após a eliminação do Token, o sistema tentará obter um novo token na próxima comunicação com o WebService específico.


9 - Esta funcionalidade foi criada nas rotinas abaixo:

a. Solic. Garantia JD (OFINJD15);

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

c. Cotações JDQuote (VEIA110);

d. PO JDQuote (VEIA112).


10 - Para realizar a limpeza do token, no browse de qualquer uma das rotinas citadas acima, selecione a opção Outras Ações \ Limpar Token.


11 - Após selecionar essa opção, o sistema realizará a limpeza do token e retornará uma mensagem de aviso ao usuário informando que o token foi removido.



04. DEMAIS INFORMAÇÕES

Esta atualização de dicionários estará disponível na próxima release (12.1.30).


05. ASSUNTOS RELACIONADOS

Não há.


Templatedocumentos


HTML
<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>