Árvore de páginas

Versões comparadas

Chave

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

← Página Inicial

Painel
titleIntrodução

A funcionalidade

...

Onboarding tem o propósito de auxiliar o usuário no

...

primeiro acesso, sendo exibido ao iniciar a aplicação

...

pela primeira vez ou selecionando a opção de ajuda no canto superior direito, ao lado do ícone de perfil.

Image Modified

Informações técnicas

Para a criação da feature, utilizamos componentes do framework PO-UI para facilitar e agilizar o desenvolvimento, sendo:

<po-modal>https://po-ui.io/documentation/po-modal

<po-checkbox> - https://po-ui.io/documentation/po-checkbox

<po-button>https://po-ui.io/documentation/po-button

Foi desenvolvido uma classe REST de controle para entrada e saída de dados através da linguagem TLPP, sendo responsável por

gerações

geração e

gravações

gravação de registros nas tabelas de perfil de usuário do Framework.

Estruturação da API:

Image Removed

Especificações de Serviços:

Section
Painel
title(/) Informações Técnicas
Front End
Painel
titleBack End
Expandir
titleGET /api/v1/acUser/:userId

Retorna o status do perfil do usuário informado:

Bloco de código
languagejs
themeConfluence
{
		"showModal": true,
		"userId": 000000,
		"userName": "Administrador"
}

Descrição de Campos:

  • showModal: boolean – Define se será apresentado o Onboarding
  • userId: string – Retorno o código do usuário consultado
  • userName: string – Retorna nome do usuário consultado
Expandir
titlePOST /api/v1/acUser/:userId

Permite cadastrar um novo registro de perfil de usuário com as definições passadas pelo body da requisição.

Bloco de código
languagejs
themeConfluence
{
		"showModal": false,
}

O seu retorno esperado será:

Bloco de código
languagejs
themeConfluence
{
		"showModal": false,
		"userId": "000000",
		"userName": "Administrador"
}

Descrição de Campos:

  • showModal: boolean – Define se será apresentado o Onboarding
  • userId: string – Retorno o código do usuário consultado
  • userName: string – Retorna nome do usuário consultado


Expandir
titlePUT /api/v1/acUser/:userID

Permite alterar o status da configuração de perfil do usuário através da informações passadas pelo body da requisição.

Bloco de código
languagejs
themeConfluence
{
		"showModal": true,
}
Bloco de código
languagejs
themeConfluence
{
		"showModal": true,
		"userId": "000000",
		"userName": "Administrador"
}

Descrição de Campos:

  • showModal: boolean – Define se será apresentado o Onboarding
  • userId: string – Retorno o código do usuário consultado
  • userName: string – Retorna nome do usuário consultado


Expandir
titleGET api/acConfigProf/v1/profile/restore
Permite alterar

Retorna o status da configuração de perfil do usuário através da informações passadas pelo body da requisição.

Bloco de código
languagejs
themeConfluence
{
		"showModal": true,
}
Bloco de código
languagejs
themeConfluence
{
		"showModal": true,
		"userId": "000000",
		"userName": "Administrador"
}

Descrição de Campos:

  • showModal: boolean – Define se será apresentado o Onboarding
  • userId: string – Retorno o código do usuário consultado
  • userName: string – Retorna nome do usuário consultado


← Página Inicial