Árvore de páginas

Versões comparadas

Chave

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

...

Painel
titleDocumentação API
Expandir
titlePadrão de documentação

O padrão para a documentação das APIs utilizado é o OpenAPI v3.

Para agilizar a documentação temos a ferramenta da engenharia com interface gráfica no link:  OpenAPI-GUI v3

Outra ferramenta é a extensão OpenAPI do VSCode. Nela podemos escrever o arquivo yml e visualizar utilizando o Swagger UI.



Expandir
titleRepositório de API

Definição...

Exemplo:





Expandir
titleSolução de Problemas

Segue abaixo os links de acesso as documentações de FAQs de Produtos do BackOffice desenvolvidos em PO UI com público-alvo geral, ou seja, é destinado a Desenvolvedores, Suporte Técnico e também para Clientes:


FAQ - Dashboard BackOffice


FAQ - Portal Gestão de Vendas


FAQ - Acompanha Custos (OBS: No final da página)


Segue abaixo o link de acesso a documentação de uma FAQ destinada a equipe de Suporte Técnico para apoio ao atendimento de tickets de Clientes:


PO UI - Documento de apoio ao suporte




Painel
titlePersonalização
Expandir
titleAdicionar campos em formulários
Expandir
titleQuando utilizar?

Este modelo de personalização pode ser utilizado em produtos que possuem um escopo de campos fixos e que não utilize o dicionário de dados do TOTVS Backoffice (Linha Protheus) como provedor de campos do formulario.

Expandir
titleComo adicionar campos?
Expandir
titleProtheus (backend)

O Protheus (backend) deve enviar os campos para a aplicação através de uma API REST, está poderá utilizar um parâmetro (SX6) ou um ponto de entrada onde o usuario poderá informar quais campos deseja adicionar no formulario.


Esta API será responsavel por prover uma lista de campos personalizados, onde os campos devem ser retornados da interface PoDynamicFormField do componente

Dynamic Form, podendo utilizar o dicionário de dados (SX3) do Protheus como base da estrutura.


Bloco de código
languagejs
linenumberstrue
{
	"fields": [
		{
			"property": "c5_recfaut",
			"label": "Pag.Fret.Aut",
			"help": "Pagto do frete autonomo",
			"gridSmColumns": 12,
			"gridMdColumns": 6,
			"gridLgColumns": 4,
			"gridXlColumns": 4,
			"forceOptionsComponentType": "ForceOptionComponentEnum.select",
			"options": [
				{
					"value": "1",
					"label": "Emitente"
				},
				{
					"value": "2",
					"label": "Transportador"
				}
			],
			"disabled": false,
			"required": false,
			"showRequired": true,
			"clean": true,
			"default": false
		}
	]
}


Exemplo de ponto de entrada:

Expandir
titleAplicação (frontend)

Para personalizar os formulários podem ser utilizados os componentes do dynamic form e o dynamic view da biblioteca PO-UI estes componentes permite criar um formulario ou uma visualização dinâmica, podendo exibir os campos em um container ou widget.


Informações
titleSugestão

Para reduzir o tempo de carregamento da tela, os campos podem ser carregados previamente e serem armazenados na aplicação.


Exemplo de uso:

Image Added

Expandir
titleRemover campos

Definição...

Exemplo:

Painel
titlePróximo Tópico
Expandir
titleA definir...

Definição...

Exemplo:





...