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 do Estabelecimento OF (html.mof.establishmentItemParameters). 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

Segue abaixo a lista de 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/establishmentItemsParameters.p

Manipulação de Objetos da Interface (Metadata)
Endpoint	Evento	Entrada	Observação
getMetaData	edit	Metadados	Estrutura metadados da tela de inclusão de parâmetros do estabelecimento.
getMetaData	view	Metadados	Estrutura metadados da tela de visualização de parâmetros do estabelecimento.

Manipulação de Dados
Endpoint	Evento	Entrada	Observação
GetEstablishmentItemsParameters	beforeGetEstablishmentItemsParameters	Payload, PathParams, QueryParams	Executado antes de buscar um parâmetro específico.
GetEstablishmentItemsParameters	afterGetEstablishmentItemsParameters	Payload, PathParams, QueryParams	Executado depois de buscar um parâmetro específico.
QueryEstablishmentItemsParameters	beforeQueryEstablishmentItemsParameters	Payload, PathParams, QueryParams	Executado antes de buscar os parâmetros.
QueryEstablishmentItemsParameters	afterQueryEstablishmentItemsParameters	Payload, PathParams, QueryParams	Executado depois de buscar os parâmetros.
UpdateEstablishmentItemsParameters	beforeUpdateEstablishmentItemsParameters	Payload, PathParams, QueryParams	Executado antes da alteração de um parâmetro.
UpdateEstablishmentItemsParameters	afterUpdateEstablishmentItemsParameters	Payload, PathParams, QueryParams	Executado depois da alteração de um parâmetro.

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/establishmentItemsParameters/metadata?type=edit&establishment=<codigo estabelecimento>	Utiliza o código do estabelecimento como Query Param.
Visualização de Parâmetros	https://<servidor>:<porta>/api/ofp/v1/establishmentItemsParameters/metadata?type=view&establishment=<codigo estabelecimento>	Utiliza o código do estabelecimento como Query Param.

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

a) Tela - Formulário de Parâmetros do Item do Estabelecimento
Âncora
4a
4a

A tela de formulário de parâmetros do item do estabelecimento não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-edit, mas sim o po-page com componentes como po-input, po-decimal, entre outros. Por isso, alguns elementos da tela não podem ser customizados.

Propriedade

Descrição

configurationTabForm

Formulário dinâmico da seção Configuração do parâmetro do item 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 é longo. 
"configurationTabForm": [
        {
            "gridColumns": 3,
            "divider": "Tributação ICMS",
            "property": "icmsRate",
            "label": "Alíquota ICMS interna",
            "placeholder": "Insira a alíquota de ICMS interna",
            "type": "currency",
            "order": 1
        },
        {
            "gridColumns": 3,
            "divider": "GIA ICMS - MS",
            "property": "inventoryTaxCode",
            "options": [
                {
                    "label": "Não informado",
                    "value": "0"
                },
                {
                    "label": "Tributado",
                    "value": "1"
                },
                {
                    "label": "Isento",
                    "value": "2"
                },
                {
                    "label": "Outras",
                    "value": "3"
                },
                {
                    "label": "Não tributado",
                    "value": "4"
                },
                {
                    "label": "Substituição tributária",
                    "value": "5"
                }
            ],
            "label": "Código da tributação no inventário",
            "type": "string",
            "order": 2
        },
        {
            "forceBooleanComponentType": "checkbox",
            "gridColumns": 3,
            "divider": "SPED FISCAL",
            "booleanTrue": "Ativado",
            "property": "generateAtomicItem",
            "booleanFalse": "Desativado",
            "label": "Gerar item atômico",
            "type": "boolean",
            "order": 3
        }, 
]

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.

05. Observações Gerais
Âncora
5
5

Todos os objetos que não foram mencionados, a princípio, não podem ser customizados.
Caso deseje customizar algum componente além dos descritos neste documento e na documentação padrão de customização do PO-UI, por favor, abra um ticket solicitando a customização e justificando a necessidade.
Clique Clique aqui para para baixar um exemplo de código fonte de UPC para este programa.

Árvore de páginas

Versões comparadas

Versão antiga 2

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/establishmentItemsParameters.p

03. JSON de metadata
Âncora
3
3

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

a) Tela - Formulário de Parâmetros do Item do Estabelecimento
Â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 2

Nova versão Atual

Chave

CONTEÚDO

01. Visão Geral Âncora11

02. API x Pontos UPC Relacionados Âncora22

API REST - ofp/api/v1/establishmentItemsParameters.p

03. JSON de metadata Âncora33

04. Especificidades de Customização Âncora44

a) Tela - Formulário de Parâmetros do Item do Estabelecimento Â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 do Item do Estabelecimento
Âncora
4a
4a

05. Observações Gerais
Âncora
5
5