Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Ederson Tonial

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Ederson Tonial

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
titleImportante

Essa funcionalidade será expedida na versão Totvs 12.1.2603 e também será  liberada via console nos patches 12.1.2507.6, 12.1.2503.12 e 12.1.2411.17.

CONTEÚDO

  1. Visão Geral
  2. API x Pontos UPC Relacionados
  3. JSON de metadata
  4. Especificidades de customização 
  5. Observações Gerais

...

Este documento tem como objetivo descrever o que poderá ser customizado na tela HTML do programa Parâmetros evento tributos Cadastro cClasstrib (html.mcdmre.paramEventoTributoscClassTrib).
Aqui será descrito quais componentes e elementos podem ser customizados.

...

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

getMetaData
Manipulação de Objetos da Interface (Metadata)
EndpointEventoEntradaObservaçã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.

Executado depois da eliminação de um lote de registros

copy

Metadados

Estrutura metadados da tela de cópia/duplicação de registro.

Manipulação de Dados
EndpointEventoEntradaObservaçã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.

deleteList

beforeDeleteList

Payload

Executado depois da eliminação de um lote de registros.

deleteList

afterDeleteList

Payload

generateData

beforeGenerateData

JsonVar: Objeto contendo:

  • pathParams: O PathParams da requisição;
  • queryParams: O QueryParams da requisição;
  • payload: Objeto de Payload da requisição.

Executado antes de acionar a funcionalidade de "Gerar dados" no topo da página.

generateData

afterGenerateData

JsonVar: Objeto contendo:

  • pathParams: O PathParams da requisição;
  • queryParams: O QueryParams da requisição;
  • payload: Objeto de Payload da requisição;
  • root: Objeto devolvido pela API-REST, conforme o tipo de retorno (Object = oOutput / Array = aResult).

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
Âncora
3
3

...

TipoEndpointObservações
Listagem

https://<servidor>:<porta>/api/cdp/v1/paramEventoTributoscClassTrib/metadata/?type=list


Inclusão

https://<servidor>:<porta>/api/cdp/v1/paramEventoTributoscClassTrib/metadata/?type=new


Edição

https://<servidor>:<porta>/api/cdp/v1/paramEventoTributoscClassTrib/metadata/<cod estabelec cClassTrib + '|' + cod evento + '|' + tipo-documento>1'>?type=edit

Utiliza o código do estabelecimento, código do evento e tipo do documento (1-NF-e, 2-CT-e, 3-NFS-e) cClass trib e fixo '1' como path param.

Duplicar/CópiaVisualização

https://<servidor>:<porta>/api/cdp/v1/paramEventoTributoscClassTrib/metadata/<cod estabelec cClassTrib + '|' + cod evento + '|' + tipo-documento>1'>?type=copydetail

Utiliza o código do estabelecimento, código do evento e tipo do documento (1-NF-e, 2-CT-e, 3-NFS-e) cClass trib e fixo '1' como path param.

04. Especificidades de Customização
Âncora
4
4

Não há especificidades nessa na listagem dessa tela, está sendo utilizado na listagem o componente dinâmico completo (po-page-dynamic-table).

Na edição há um formulário dinâmico padrão recebendo os fields que podem ser alterados por meio de UPCdois formulários dinâmicos:

  1. No topo recebendo o array fieldsKey contendo os campos: Código, Datas, Nome e Descrição;
  2. 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 
Âncora
5
5

...