Histórico da Página

CONTEÚDO

01. Visão Geral
Âncora
1
1

Este documento tem como objetivo detalhar as possibilidades de personalização na tela HTML do programa Parâmetros Itens Obrigações Fiscais (html.mof.ParamItemsTaxObligations). Serão descritos os componentes e elementos passíveis de customização.

Aviso

title	Importante

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.

02. API x Pontos UPC Relacionados
Âncora
2
2

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.

API REST - ofp/api/v1/

...

itemsParametersOF.p

Manipulação de Objetos da Interface (Metadata)
Endpoint	Evento	Entrada	Observação
getMetaData	newedit	Metadados	Estrutura metadados da tela de inclusão edição de parâmetros do estabelecimento.	getMetaData	edit	Metadados	Estrutura metadados da tela de inclusão de parâmetros do estabelecimentodos itens de obrigações fiscais.
getMetaData	view	Metadados	Estrutura metadados da tela de visualização de parâmetros do estabelecimentodos itens de obrigações fiscais.

Manipulação de Dados
Endpoint	Evento	Entrada	Observação
GetItemsParametersOF	beforeGetEstablishmentParametersGetItemsParametersOF	Payload, PathParams, QueryParams	Executado antes de buscar um documento parâmetro de item específico.
GetItemsParametersOF	afterGetEstablishmentParametersGetItemsParametersOF	Payload, PathParams, QueryParams	Executado depois de buscar um documento parâmetro de item específico.
QueryQueryItemsParametersOF	beforeQueryEstablishmentParametersbeforeQueryItemsParametersOF	Payload, PathParams, QueryParams	Executado antes de buscar os documentosparâmetros de itens.
QueryQueryItemsParametersOF	afterQueryEstablishmentParametersafterQueryItemsParametersOF	Payload, PathParams, QueryParams	Executado depois de buscar os documentosparâmetros de itens.
CreateUpdateItemsParametersOF	beforeCreateEstablishmentParametersbeforeUpdateItemsParametersOF	Payload, PathParams, QueryParams	Executado antes da alteração de criar um documentoparâmetro de item.
CreateUpdateItemsParametersOF	afterCreateEstablishmentParametersafterUpdateItemsParametersOF	Payload, PathParams, QueryParams	Executado depois da criação alteração de um documentoparâmetro de item.
UpdatetemsParametersOF	beforeUpdateEstablishmentParameters	Payload	Executado antes da alteração de um documento.
UpdatetemsParametersOF	afterUpdateEstablishmentParameters	Payload	Executado depois da alteração de um documento.

...

03. JSON de metadata
Âncora
3
3

É

...

É possível retornar os metadados das telas para analisar a estrutura do JSON, executando as requests abaixo (após realizar o login no produto Datasul):

Tipo	Endpoint	Observações
Edição de Parâmetros	https://<servidor>:<porta>/api/ofp/v1/itemsParametersOF/metadata?type=edit	Utiliza o código do item como Query Param
Visualização de Parâmetros	https://<servidor>:<porta>/api/ofp/v1/itemsParametersOF/metadata?type=view	Utiliza o código do item como Query Param

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

a) Tela - Formulário de Parâmetros Itens de Obrigações Fiscais
Âncora
4a
4a

A tela não utiliza o componente dinâmico completo (po-page-dynamic-edit), mas sim po-page com componentes como po-input, po-decimal, entre outros. Portanto, alguns elementos não podem ser customizados.

Propriedade	Descrição

generalTabForm

scancFuelDistributorForm

Formulário dinâmico da

seção Processos Operacionais da aba Geral

aba SCANC Distribuidora de combustível, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código

title	Exemplo
collapse	true

"scancFuelDistributorForm":

[
         {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/ofp/v1/itensObligations",
            "columns": [
                {
                    "property": "productCode",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "description",
                    "label": "Descrição",
                    "type": "string"
                },
                {
                    "property": "measureUnit",
                    "label": "Unidade medida",
                    "type": "string"
                }
            ],
            "fieldLabel": "measureUnit",
            "property": "productCode",
            "format": [
                "productCode",
                "description"
            ],
            "label": "Código produto",
            "placeholder": "Selecione o código do produto",
            "type": "string",
            "fieldValue": "productCode",
            "order": 1
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/ofp/v1/productStockVariation",
            "columns": [
                {
                    "property": "code",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "description",
                    "label": "Descrição",
                    "type": "string"
                },
                {
                    "property": "unity",
                    "label": "Unidade medida",
                    "type": "string"
                }
            ],
            "fieldLabel": "unity",
            "property": "productStockVariation",
            "format": [
                "code",
                "description"
            ],
            "label": "Produto variação estoque",
            "placeholder": "Selecione o código do produto",
            "type": "string",
            "fieldValue": "code",
            "order": 2
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 3,
            "property": "stateDivisionProducing",
            "label": "% Repartição UF do produtor",
            "placeholder": "Insira a % de repartição por UF do produtor",
            "type": "currency",
            "decimalsLength": 2,
            "order": 3
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 3,
            "property": "stateDivisionDestination",
            "label": "% Repartição UF de destino",
            "placeholder": "Insira a % de repartição por UF de destino",
            "type": "currency",
            "decimalsLength": 2,
            "order": 4
        }

configurationTabForm

scancRefineryForm

Formulário dinâmico da

seção Configuração da aba Fiscal do parâmetro do estabelecimento

aba SCANC Refinaria dos parâmetros dos itens de obrigações fiscais, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código

title	Exemplo
collapse	true

Obs

"scancRefineryForm":

Este exemplo contém apenas alguns campos do formulário, pois o JSON completo desta aba é longo. repaymentSPEDForm

Formulário dinâmico da seção Ressarcimento SPED Fiscal da aba Fiscal do parâmetro do estabelecimento, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código

title	Exemplo
collapse	true

Obs: Este exemplo contém apenas alguns campos do formulário, pois o JSON completo desta aba é

[
        {
            "gridColumns": 6,
            "property": "refineryProduct",
            "label": "Produto refinaria",
            "placeholder": "Insira o produto refinaria",
            "type": "string",
            "maxLength": 10,
            "order": 5
        },
        {
            "gridColumns": 6,
            "searchService": "/dts/datasul-rest/resources/prg/ofp/v1/productStockVariation",
            "columns": [
                {
                    "property": "code",
                    "label": "Código",
                    "type": "string"
                },
                {
                    "property": "description",
                    "label": "Descrição",
                    "type": "string"
                },
                {
                    "property": "unity",
                    "label": "Unidade medida",
                    "type": "string"
                }
            ],
            "fieldLabel": "unity",
            "property": "productRegNF",
            "format": [
                "code",
                "description"
            ],
            "label": "Produto reg NF",
            "placeholder": "Selecione o código do produto",
            "type": "string",
            "fieldValue": "code",
            "order": 6
        }
    ]

spedForm

Formulário dinâmico da aba Campos SPED dos parâmetros dos itens de obrigações fiscais, deve vir um array de objetos que implementam a interface PoDynamicFormField.

Bloco de código

title	Exemplo
collapse	true

"spedForm": [
        {
            "gridColumns": 6,
            "property": "IPIFramework",
            "label": "Enquadramento IPI",
            "placeholder": "Insira o enquadramento IPI",
            "type": "string",
            "maxLength": 5,
            "order": 7
        },
        {
            "thousandMaxlength": 3,
            "gridColumns": 6,
            "property": "internalICMSRate",
            "label": "Alíquota ICMS interna",
            "placeholder": "Insira a alíquota de ICMS interna",
            "type": "currency",
            "decimalsLength": 2,
            "order": 8
        }
    ]

pageCustomActions

Este objeto permite customizar as ações da página, sendo adicionado ao lado de ações como "Salvar", "Voltar", "Cancelar" e "Salvar e Novo" dentro da página do formulário. Para adicionar uma ação customizada, é necessário criar um novo objeto e adicionar à lista pageCustomActions. Este objeto deve conter os seguintes atributos: action e label. O atributo action, deve receber o endereço de um endpoint do tipo POST de uma API do Datasul, enquanto o atributo label deve receber o título do botão em tela. Segue exemplo de JSON de retorno com o objeto pageCustomActions customizado:

Bloco de código

title	Exemplo
collapse	true

{
    pageCustomActions: [
	 {
		"action": "/dts/datasul-rest/resources/prg/ofp/v1/fiscalDocument/validateFormItem",
		"label": "Meu botão customizado"
	 }
   ]       
}

Esta documentação disponibiliza um exemplo de UPC que permite customizar as ações da página desta tela

longo

.

05. Observações Gerais
Âncora
5
5

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.

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

CONTEÚDO

01. Visão Geral
Âncora
1
1

02. API x Pontos UPC Relacionados
Âncora
2
2

API REST - ofp/api/v1/

itemsParametersOF.p

03. JSON de metadata
Âncora
3
3

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

a) Tela - Formulário de Parâmetros Itens de Obrigações Fiscais
Âncora
4a
4a

05. Observações Gerais
Âncora
5
5

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

CONTEÚDO

01. Visão Geral Âncora11

02. API x Pontos UPC Relacionados Âncora22

API REST - ofp/api/v1/

itemsParametersOF.p

03. JSON de metadata Âncora33

04. Especificidades de Customização Âncora44

a) Tela - Formulário de Parâmetros Itens de Obrigações Fiscais Âncora4a4a

05. Observações Gerais Âncora55

01. Visão Geral
Âncora
1
1

02. API x Pontos UPC Relacionados
Âncora
2
2

03. JSON de metadata
Âncora
3
3

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

a) Tela - Formulário de Parâmetros Itens de Obrigações Fiscais
Âncora
4a
4a

05. Observações Gerais
Âncora
5
5