Frameworksp

Páginas filhas
  • Protocolo OIDC e Pré-Requisitos

Versões comparadas

Versão antiga 1

changes.mady.by.user Jonatas de Carvalho Martins

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Jonatas de Carvalho Martins

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Painel
borderColor#29b6c5
titleColor#FFFFFF
titleBGColor#29b6c5
borderStylesolid
titleSobre

O processo de amarração Protheus x Smart View consiste em uma ferramenta que simplifica a utilização e manutenção dos recursos criados via Smart View. A ferramenta disponibiliza uma interface para que o administrador Protheus consiga visualizar todos os recursos disponíveis, realizar alterações, mudar a amarração entre um relatório padrão e um relatório customizado e cadastrar novos recursos customizados.

Os recursos cadastrados na tabela de amarração (Home) podem ser executados através da classe totvs.framework.smartview.callSmartView

Observação:

A ferramenta estará disponível no menu do Configurador a partir da release 12.1.2310, porém é possível adicioná-la manualmente, chamando a função APCFG770.

Expandir
titleAdicionar ferramenta no menu

Image Removed

OpenID Connect ou OIDC é um protocolo de identidade que utiliza os mecanismos de autorização e autenticação do OAuth 2.0. Também pode ser usado para login único (SSO) em todos os aplicativos. O OIDC usa JSON Web Tokens (JWT) e fluxos HTTP e evita o compartilhamento de credenciais do usuário com serviços. Dessa forma a utilização desse recurso associada a integração com Totvs Identity garante maior segurança no fluxo de login entre as soluções e APP's. 

Painel
borderColor#29b6c5
titleColor#FFFFFF
titleBGColor#29b6c5
borderStylesolid
titleInformações complementares

Pré-requisitos:

  • A amarração Protheus x Smart View encontra-se disponível a partir da lib 20230626;
  • Obrigatória ativação da Porta Multiprotocolo e Interface Protheus com PO UI (vide Nova interface do Protheus com PO UI);
  • Novo Smart View implantado.

Documentações complementares:

  • Release do Protheus igual ou superior à 12.1.2310
  • LIB igual ou superior à abril de 2025
  • Ambiente com Totvs Idenity configurado
  • Configuração com SmartLink habilitada


Documentações complementares:

A opção de menu "Home", apresenta a lista de integrações do Protheus com o Smart View. Nela também é possível incluir, alterar ou excluir integrações.

Ao acessar a rotina, a tela abaixo será apresentada:

Image Removed  

Campos apresentados:

  • Id do Smart View - Código do recurso (relatório, tabela ou visão) dentro do Smart View.
  • Id do Protheus - Código do recurso dentro do Protheus.
  • Descrição - Descrição do recurso para identificação.
  • Dt. Criação - Data da criação do recurso
  • Dt. Ult. Atualização - Data da última alteração
  • Tipo - Tipo do recurso (pivot-table para Tabela de Dados, data-grid para Visão de Dados ou report para Relatório).
  • Status - Indica se o recurso está atualizado no Protheus, ou seja, se não há divergências no recurso entre o Smart View e o Protheus.

Nesta tela, é possível realizar dois tipos de pesquisa, a busca simples ou a busca avançada.

  • Simples - Localizada no topo da página, permite digitar um valor que será buscado nos campos principais (Id do Smart View, Id do Protheus, Descrição e Tipo)

Image Removed

  • Busca Avançada - Permite buscas mais específicas, direcionadas a um ou mais campos:

Image Removed

Painel
titleCampos e estrutura de dados

Após verificar se o sistema atende aos Pré-Reqisitos listados acima garantir que na tabela de usuários do sistema (SYS_USR) os campos "Utiliza OIDC" e 

Painel
borderColor#29b6c5
titleColor#FFFFFF
titleBGColor#29b6c5
borderStylesolid
titleProcessos
Expandir
titleHome - Integração Smart View
Expandir
titleVisualização
Expandir
titleFiltros
Expandir
titleDetalhes

Para visualizar os detalhes de uma integração, basta clicar na opção 'Detalhes' à esquerda do item:

Image Removed

Expandir
titleInclusão

Na inclusão, podem ser incluídos três tipos de integração: Relatórios, Tabelas dinâmicas ou Visões de Dados. Esses tipos correspondem ao que foi cadastro no portal do Smart View.

Para incluir uma nova integração, basta clicar na opção 'Novo' e preencher os campos, sendo que o campo "Id do Smart View" só será liberado para edição quando o campo "Tipo" for preenchido.

CampoDescriçãoId do ProtheusNome do recurso que será chamado via callSmartView.SubtítuloNome complementar para o recurso, pois um mesmo objeto de negócio pode ser utilizado para N layouts.DescriçãoDescrição do registro. Exemplo: Relatório de funcionários admitidos até mês X.TipoTipo do recurso, podendo ser Relatório, Tabela dinâmica ou Visão de dados.Id do Smart ViewRelatório/tabela/visão que está cadastrada no portal do Smart View.

Image Removed

Aviso
titleImportante

Não é permitido incluir mais de um registro com o mesmo Id do Protheus, Tipo e Subtítulo. Em caso de duplicidade, será apresentada a mensagem "Registro com o ID ID_DO_PROTHEUS.SUBTITULO e tipo data-grid/report/pivot-table já existente".

Expandir
titleAlteração

A alteração segue as mesmas regras da inclusão, sendo que, para ser realizada, basta clicar nos três pontos à esquerda do registro e clicar na opção "Editar".

Image Removed

Expandir
titleExclusão

Para excluir um registro, basta clicar nos três pontos à esquerda do item e selecionar a opção "Excluir". Será apresentada uma mensagem para que a exclusão seja confirmada.

Image Removed

Expandir
titlePersonalização de Campos - A partir da lib 20230918

A opção de menu "Personalização de Campos", permite adicionar novos campos em um objeto de negócio. Por exemplo: o módulo de Faturamento liberou um objeto de negócio para que pudessem ser criados recursos para a visualização de clientes, porém não foi disponibilizado o campo A1_TIPO para visualização. Sendo assim, o usuário pode utilizar essa rotina para adicionar esse campo e qualquer outro que seja de seu interesse.

Aviso
titleAtenção
  • Não é possível adicionar campos MEMO ou virtual.
Expandir
titleListagem dos objetos de negócio

Ao clicar na opção de menu, a primeira tela que será apresentada, é a de listagem com todos os objetos de negócio disponíveis para customização.

Image Removed

A listagem também disponibiliza uma busca simples, podendo buscar por qualquer uma das colunas: Nome, Tabelas customizáveis, Objeto de Negócio ou Módulo:

Image Removed

Expandir
titleAdicionar campos

Para adicionar novos campos no objeto de negócio, basta clicar na opção "Editar" do lado esquerdo do item que deseja customizar:

Image Removed

Ao clicar em "Editar", será apresentada uma tela com todas as tabelas customizáveis e seus respectivos campos. Sendo que a tela é dividida em duas partes:

  1. Adicionar campos
    1. Essa é a seção para selecionar a tabela desejada no campo "Tabela", selecionar o campo que deseja adicionar em "Campo" e informar uma descrição para ele em "Descrição";
    2. Ao clicar em "Adicionar" o campo fica com o status de "Adicionado", informando que o mesmo foi adicionado, porém ainda não foi enviado para o objeto de negócio.
  2. Campos atuais
    1. Essa é a seção que apresenta uma tabela com os campos atuais do objeto de negócio e os novos que forem sendo adicionados;
    2. A tabela possui três colunas, sendo que a última (Customização) apresenta o status de customização para aquele campo, sendo:
      1. Padrão: campo que foi adicionado por padrão pelo módulo;
      2. Customizado: campo que foi adicionado pelo usuário e já está disponível para uso no objeto de negócio;
      3. Adicionado: campo que foi adicionado pelo usuário mas que ainda não está disponível para uso no objeto de negócio.
    3. Nessa parte, é possível excluir campos. Porém, só é possível excluir aqueles com status de "Adicionado".

Uma vez que os campos foram adicionados e a alteração já foi confirmada, agora os campos adicionados aparecerão para utilização no objeto de negócio. Exemplo: no gif acima, foi adicionado o campo A2_INSCRM da tabela SA2 com a descrição "Meu novo campo". Agora consigo visualizá-lo nos recursos do Smart View:

Image Removed

Aviso

Após a confirmação da inclusão do campo no objeto de negócio, não será possível excluí-lo, pois ele poderá ser utilizado em algum recurso do Smart View. A exclusão do campo pode causar erros no sistema.

Expandir
titleVisualizar campos

Para visualizar os campos e tabelas de um objeto de negócio, basta clicar na opção "Visualizar" à esquerda do item desejado:

Image Removed

Ao clicar em "Visualizar", será apresentada uma tela com todas as tabelas customizáveis e seus respectivos campos. Sendo que a tela é dividida em duas partes:

  • Adicionar campos
    1. Essa é a seção para selecionar de qual tabela serão visualizados os campos.
    • Campos atuais
  • Essa é a seção que apresenta uma tabela com os campos atuais do objeto de negócio, de acordo com a tabela selecionada em Adicionar campos;
  • A tabela possui três colunas, sendo que a última (Customização) apresenta o status de customização para cada campo, sendo:
    1. Padrão: campo que foi adicionado por padrão pelo módulo;
    2. Customizado: campo que foi adicionado pelo usuário e já está disponível para uso no objeto de negócio;
    3. Adicionado: campo que foi adicionado pelo usuário mas que ainda não está disponível para uso no objeto de negócio (esse aparece somente na tela de edição).
    • Na tela de visualização não é possível excluir ou alterar nenhum item.