Este documento tem como objetivo descrever o que poderá ser customizado na tela HTML do programa Relacionamento x Tributo item de menu Relacionamento x Tributo (html-mft.relationshipTribute), aqui será descrito quais componentes e elementos podem ser customizados.
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. |
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.
| Manipulação de Objetos da Interface (Metadata) | |||||
|---|---|---|---|---|---|
| Método (API) | Endpoint (API) | Endpoint (UPC) | Evento (UPC) | Entrada (UPC) | Observação |
| GET | URL_Base/metadata/?type=list | getMetaData | list | Metadados | Estrutura metadados da listagem. |
| GET | URL_Base/metadata/?type=new | getMetaData | new | Metadados | Estrutura metadados da tela de inclusão. |
| GET | URL_Base/metadata/<código estabelecimento>?type=edit | getMetaData | edit | Metadados | Estrutura metadados da tela de edição. |
| GET | URL_Base/metadata/<código estabelecimento>?type=copy | getMetaData | copy | Metadados | Estrutura metadados da tela de detalhes. |
| Manipulação de Dados | |||||
|---|---|---|---|---|---|
| Método (API) | Endpoint (API) | Endpoint (UPC) | Evento (UPC) | Entrada (UPC) | Observação |
| GET | URL_Base/<chave do registro> | findById | findById | Dados do registro | Executado depois de buscar um registro específico. |
| GET | URL_Base?pageSize=10&page=1 | findAll | findAll | Dados dos registros | Executado depois de buscar os registros. |
| POST | URL_Base | create | beforeCreate | Payload* | Executado antes de criar um registro. |
| POST | URL_Base | create | afterCreate | Payload* | Executado depois da criação de um registro. |
| PUT | URL_Base | update | beforeUpdate | Payload* | Executado antes da alteração de um registro. |
| PUT | URL_Base | update | afterUpdate | Payload* | Executado depois da alteração de um registro. |
| DELETE | URL_Base/<código estabelecimento> | delete | beforeDelete | Vazio | Executado antes da eliminação de um registro. |
| DELETE | URL_Base/<código estabelecimento> | delete | afterDelete | Vazio | Executado depois da eliminação de um registro. |
{
"descTpDespICMSUfDest": "INVESTIMENTO ETE",
"descTpDespFCP": "INVESTIMENTO ETE",
"estab": "1",
"ccICMSST": "",
"espICMSST": "dp",
"descEspFCP": "duplicata",
"espICMSUfDest": "dp",
"updateInfAdicAuto": false,
"descEspICMSUfDest": "duplicata",
"ctFCP": "11361198",
"updateApbAuto": true,
"tpDespICMSST": 21,
"espFCP": "dp",
"ccFCP": "",
"descEspICMSST": "duplicata",
"ctICMSUfDest": "11361198",
"ccICMSUfDest": "",
"descTpDespICMSST": "INVESTIMENTO ETE",
"tpDespFCP": 21,
"integApb": true,
"estabName": "Estabelecimento Automação - TOTVS",
"tpDespICMSUfDest": 21,
"ctICMSST": "00001116"
} |
É possível retornar o metadata das telas para fazer a análise da estrutura do JSON, executando as requests abaixo (depois de logado no produto Datasul):
Tipo | Método (API) | Endpoint (API) | Observações |
|---|---|---|---|
| Listagem | GET | URL_Base/metadata/?type=list | |
| Inclusão | GET | URL_Base/metadata/?type=new | |
| Edição | GET | URL_Base/metadata/<código estabelecimento>?type=edit | Utiliza o código do estabelecimento como path param. |
| Copia | GET | URL_Base/metadata/<código estabelecimento>?type=copy | Utiliza o código do estabelecimento como path param. |
a) Tela - Listagem Relacionamento x Tributo
A tela de listar não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-table por exemplo, e sim usando po-page com uma po-table, por conta disso alguns elementos da tela não podem ser customizados e algumas propriedades do metadata são utilizados de forma um pouco diferente, a seguir a descrição de cada customização possível.
| Propriedade | Description | |
|---|---|---|
| title | Título da página.
| |
| pageCustomActions | Utilizado para remover o botão de novo parâmetros ou para inserir novos botões, o botão inserido aqui deve conter label e url.
| |
| tableCustomActions | Utilizado para remover os botões de editar, copiar e deletar das ações da tabela ou para inserir novos. Para que uma ação padrão não seja criada basta que o metadata não contenha os labels de edit, duplicate e Delete, caso necessário criar ou ação diferente ela deve possuir tanto label quanto url.
| |
| columnsList | Lista das colunas da tabela, contém um array de objetos que implementam a interface PoTableColumn. Para mais informações do que é possível acessar a documentação do Portinari: po-table
| |
| detailedInfoDynamicViewFields | Expansão da linha da tabela, dados completos da tabela. Neste componente é utilizado o po-dynamic-view e todas as propriedades do PoDynamicViewField podem ser utilizadas.
| |
| advancedFilters | Busca avançada da tela, permite o filtro pelos valores preenchidos. Neste componente é utilizado o po-dynamic-form e todas as propriedades do PoDynamicFormField podem ser utilizadas.
|
