Histórico da Página
...
- Visão Geral clique no conteúdo para acesso rápido à informação desejada ↓
- API x Pontos UPC Relacionados
- JSON de metadata
- Especificidades de Customização
- Observações Gerais
01. Visão Geral Âncora 1 1
| 1 | |
| 1 |
...
02. API x Pontos UPC Relacionados Âncora 2 2
| 2 | |
| 2 |
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:
ftp/api/v1/refRelationshipTribute.p.
URL base para requisições: https://<servidor>:<porta>/api/ftp/v1/refRelationshipTribute.p.
| 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><ROWID do registro>?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 <ROWID 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. |
| POST | URL_base/VALIDATE | validateForm | validateForm | Payload* e Campo alterado | Executado ao chamar a rota de Validate. |
| 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><ROWID do registro> | delete | beforeDelete | Vazio | Executado antes da eliminação de um registro. |
| DELETE | URL_Base/<código estabelecimento><ROWID do registro> | delete | afterDelete | Vazio | Executado depois da eliminação de um registro. |
...
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><chave do registro>?type=edit | Utiliza o código a chave do estabelecimento registro como path param. |
| Copia | GET | URL_Base/metadata/<código estabelecimento><chave do registro>?type=copy | Utiliza o código a chave do estabelecimento registro como path param. |
04. Especificidades de Customização Âncora 4 4
| 4 | |
| 4 |
...
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 | DescriptionDescrição | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| title | Título da página.
| |||||||||||
| keepfilters | Indica se deseja salvar no cache do navegador as informações do filtro de busca avançada e as preferencias das colunas (colunas visíveis e posição), recebe true ou false.
| |||||||||||
| hideColumnsManager | Indica se deseja exibir o gerenciador de coluna da tabela, recebe true ou false.
| |||||||||||
| pageCustomActions | Utilizado para remover o botão de novo parâmetros ou para inserir | 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.
|
b) Tela - Edição/Novo Relacionamento x Tributo Âncora 4b 4b
| Propriedade | Descrição | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| title | Título da página.
| |||||||||||
| breadcrumb | O caminho de migalhas da página, recebe a página o link para a página de listagem com label assim como também o link e label da página atual, o link de listagem deve ser "/relationshipTribute" para que ao ser clicado a pagina seja redirecionada para a tela de listagem.
| |||||||||||
| getDefault | Indica se ao abrir a página de criação de um novo registro deve busca os valores padrões ou não, recebe true ou false. OBS: Valores padrões (pode ser customizado): IBS UF, nota de entrada, "* - todos *" para as informações principais e 0 para as alíquotas e percentuas.
| |||||||||||
| pageCustomActions | Indica quais ações a tela terá, por padrão irá criar "Salvar, Salvar e Continuar e Voltar", para remover a ação basta remover o label da ação que deseja que não apareça, pode ser retornar "URL" junto com o label para indicar para onde deve ser redirecionado ao clicar, a url da tela de listagem é "/relationshipTribute".
| |||||||||||
| validateFields | Indica quais campos do po-dynamic-form ira executar a validação ao sair do campo, a validação em sí é feita na API de dados "/dts/datasul-rest/resources/prg/ftp/v1/refRelationshipTribute/validate", enviando para a API qual campo foi modificado e o registro completo. Para saber mais sobre o que pode ser feito com este campo, consulte a documentação do PO-UI: PoDynamicFormValidation
| |||||||||||
| createDynamicFormFields | formulário dinâmico do cadastro de Relacionamento x Tributo, deve vir um array de objetos que implementam a interface PoDynamicFormField. Para mais informações do que é possível inserir acessar a documentação do Portinari: po-dynamic-form
|
05. Observações Gerais
| Âncora | ||||
|---|---|---|---|---|
|
...









