Árvore de páginas

Versões comparadas

Chave

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

...

Este documento tem como objetivo detalhar as possibilidades de personalização na tela HTML do programa  (html.mof.ParamItemsTaxObligationscq022). Serão descritos os componentes e elementos passíveis de customização. 

Aviso
titleImportante

As customizações nativas dos componentes dinâmicos do PO-UI estão detalhadas na documentação Manual de personalização e customização PO-UI e não serão abordadas neste documento.

...

Abaixo estão listadas as APIs e Pontos de UPC responsáveis pelo processamento da interface dinâmica e dos dados do programa. Para mais detalhes sobre como cadastrar uma UPC para essa API, consulte o tópico 5 da documentação  Customização PO-UI.

A API REST -

...

cqp/api/v1/

...

fichaCQInspecao.p

...

deve ser cadastrada no menu do Datasul para que seja possível informar o programa customizado do cliente.

Nesta API REST foi implementada a técnica de chamada de UPC padrão para APIs REST Datasul.

O programa customizado (UPC) deverá tratar os seguintes parâmetros:
•    Endpoint: identifica o método que está sendo executado
•    Evento: identifica o evento/ponto UPC dentro do método
•    Programa: nome do programa que está sendo executado (API REST)
•    Objeto JSON: handle do objeto que contém o JSON que está sendo recebido ou retornado pelo método


Manipulação de Objetos da Interface (Metadata)
Manipulação de Objetos da Interface (Metadata)
EndpointEventoEntradaObservação
getMetaData

new

Metadados

Estrutura metadados da tela de inclusão de parâmetros dos itens de obrigações fiscais.

getMetaData

edit

Metadados

Estrutura metadados da tela de inclusão de parâmetros dos itens de obrigações fiscais.

getMetaData

view

Metadados

Estrutura metadados da tela de visualização de parâmetros dos itens de obrigações fiscais.

Manipulação de Dados
EndpointEventoEntrada
Observação
Objetivo
GetItemsParametersOF
get
beforeGetEstablishmentParameters
findById

Payload, PathParams, QueryParams

Executado antes

Retorna os dados de

buscar

um

documento específico.GetItemsParametersOF

afterGetEstablishmentParameters

Payload, PathParams, QueryParams

Executado depois de buscar um documento específico.

QuerytemsParametersOF

beforeQueryEstablishmentParameters

Payload, PathParams, QueryParams

Executado antes de buscar os documentos.

QuerytemsParametersOFafterQueryEstablishmentParameters

único roteiro.   Permite alterar os dados retornados antes de apresentá-los na tela.

queryFindAll

Payload, PathParams, QueryParams

Executado depois de buscar os documentos.

CreatetemsParametersOF

beforeCreateEstablishmentParameters

Payload

Executado antes de criar um documento.

CreatetemsParametersOF

afterCreateEstablishmentParameters

Payload

Executado depois da criação de um documento.

UpdatetemsParametersOF

beforeUpdateEstablishmentParameters

Payload

Executado antes da alteração de um documento.

UpdatetemsParametersOF

afterUpdateEstablishmentParameters

Payload

Retorna os dados de vários roteiros, conforme filtro.   Permite alterar os dados retornados antes de apresentá-los na tela.

getResults

findSampling

Payload, PathParams, QueryParams

Executado antes de buscar os documentos.



Payload, PathParams, QueryParams

Executado depois de buscar os documentos.



Payload

Executado antes de criar

Executado depois da alteração de

um documento.













03. JSON de metadata
Âncora
3
3

...

05. Observações Gerais 
Âncora
5
5

  • O cliente deve cadastrar os grupos de usuário que terão permissão para executar este programa, mesmo ele não sendo uma tela.
  • Objetos não mencionados neste documento não podem ser customizados por padrão.

  • Caso seja necessário customizar outros componentes, além dos descritos aqui e na documentação padrão de customização do PO-UI, deve-se abrir um ticket de solicitação, justificando a necessidade.

  • Clique aqui para baixar um exemplo de código fonte de UPC para este programa.