CONTEÚDO
- Visão Geral
- API x Pontos UPC Relacionados
- JSON de metadata
- Especificidades de customização
- Observações Gerais
01. Visão Geral
Este documento tem como objetivo descrever o que poderá ser customizado na tela HTML do programa Cadastro cClasstrib (html.mre.cClassTrib).
Aqui será descrito quais componentes e elementos podem ser customizados.
Importante
Esse documento somente cita itens de customização que diferem da customização padrão de uma tela HTML utilizando PO-UI, ou seja, somente as especificidades de customização do programa HTML em questão. As customizações nativas dos componentes dinâmicos do PO-UI podem ser verificadas aqui e não serão abordadas nesse documento.
02. API x Pontos UPC Relacionados
Segue a lista de APIs e Pontos de UPC responsáveis pelo processamento da interface dinâmica e dos dados do programa.
Para maiores detalhes de como cadastrar uma UPC para essa API podem ser visualizados aqui.
API REST - cdp/api/v1/cClassTrib.p
| Manipulação de Objetos da Interface (Metadata) | |||
|---|---|---|---|
| Endpoint | Evento | Entrada | Observação |
| getMetaData | list | Metadados | Estrutura metadados da listagem. |
| getMetaData | new | Metadados | Estrutura metadados da tela de inclusão. |
| getMetaData | edit | Metadados | Estrutura metadados da tela de edição. |
| getMetaData | detail | Metadados | Estrutura metadados da tela de detalhes. |
| Manipulação de Dados | |||
|---|---|---|---|
| Endpoint | Evento | Entrada | Observação |
| findById | findById | Dados do registro | Executado depois de buscar um registro específico. |
| findAll | findAll | Dados dos registros | Executado depois de buscar os registros. |
| create | beforeCreate | Payload | Executado antes de criar um registro. |
| create | afterCreate | Payload | Executado depois da criação de um registro. |
| update | beforeUpdate | Payload | Executado antes da alteração de um registro. |
| update | afterUpdate | Payload | Executado depois da alteração de um registro. |
| delete | beforeDelete | Payload | Executado antes da eliminação de um registro. |
| delete | afterDelete | Payload | Executado depois da eliminação de um registro. |
| generateData | beforeGenerateData | JsonVar: Objeto contendo:
| Executado antes de acionar a funcionalidade de "Gerar dados" no topo da página. |
| generateData | afterGenerateData | JsonVar: Objeto contendo:
| Executado depois de acionar a funcionalidade de "Gerar dados" no topo da página. |
API REST - cdp/api/v1/planilha.p
Pode ser implementada uma UPC para captar os eventos de geração de planilha.
Detalhes dos endpoints que permitem customização estão nessa documentação.
03. JSON de metadata
É possível retornar o metadata das telas para fazer a analise da estrutura do JSON, executando as requests abaixo (depois de logado no produto Datasul):
| Tipo | Endpoint | Observações |
|---|---|---|
| Listagem | https://<servidor>:<porta>/api/cdp/v1/cClassTrib/metadata/?type=list | |
| Inclusão | https://<servidor>:<porta>/api/cdp/v1/cClassTrib/metadata/?type=new | |
| Edição | https://<servidor>:<porta>/api/cdp/v1/cClassTrib/metadata/<cod cClassTrib + '|' + '1'>?type=edit | Utiliza o código do cClass trib e fixo '1' como path param. |
| Visualização | https://<servidor>:<porta>/api/cdp/v1/cClassTrib/metadata/<cod cClassTrib + '|' + '1'>?type=detail | Utiliza o código do cClass trib e fixo '1' como path param. |
04. Especificidades de Customização
Não há especificidades na listagem dessa tela, está sendo utilizado o componente dinâmico completo (po-page-dynamic-table).
Na edição há dois formulários dinâmicos:
- No topo recebendo o array fieldsKey contendo os campos: Código, Datas, Nome e Descrição;
- O restante dos campos estão no array: fields.
Os dois arrays podem ser manipulados por uma UPC e retornados para a tela modificando ou adicionando campos.
05. Observações Gerais
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas