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.


Informações técnicas

Para a criação da feature, utilizamos componentes do framework PO-UI para facilitar, padronizar 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ção e gravação de registros nas tabelas de perfil de usuário do Framework.

Estruturação da API:














Especificações de Serviços:

Retorna o status do perfil do usuário informado:

{
		"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

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

{
		"showModal": false,
}

O seu retorno esperado será:

{
		"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


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

{
		"showModal": true,
}
{
		"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


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

{
		"showModal": true,
}
{
		"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