Histórico da Página

...

Tag	Tipo	Descrição
property	Character	Contêm o nome do campo que houve a alteração para ser validado.
value	JSonObject	Contêm uma tag para cada campo da tela contendo com os seus respectivos valores atuais dos campos.

A cada campo que for alterado e ocorrer um LEAVE, será enviado pelo PO-UI um Json que contém o campo que teve o seu valor alterado junto com todos os valores dos demais campos da tela HTML, conforme o exemplo abaixo:

Bloco de código

language	js
title	JSon enviado pelo HTML para validação dos campos
linenumbers	true
collapse	true

{
    "property": "codAcoes",
    "value": {
        "codIdiomPadr": "01 Português",
        "codIdioma": "12345678",
        "desIdioma": "12345678901234567890",
        "hraUltAtualiz": "",
        "datUltAtualiz": null,
        "id": 6,
        "codAcoes": "FocoDesIdioma"
    }
}

JSon que teremos que retornar para

...

a tela HTML

As validações do formulário, aguardam o seguinte formato de JSon:

...

Bloco de código

language	js
title	JSon empacsulado para UPC de Validação de Formulários
linenumbers	true
collapse	true

// encapsulamos o retorno para enviar para a UPC
oObj = NEW JsonObject().
oObj:add("property", cProp).
oObj:add("originalValues", oValue).
oObj:add("returnroot", oRet).

// Realiza a chamada da UPC Progress
{include/i-epcrest.i &endpoint=validateForm &event=validateForm &jsonVar=oObj}    

// obtem o retorno customizado
oRet = oObj:getJsonObject("returnroot").

Neste nosso exemplo, nós dividimos o JSon a ser enviado para UPC em três partes, que são:

Tag	Tipo	Descrição
property	Character	Comtêm o nome do campo que esta sendo validado.
originalValues	JSonObject	Contêm as tags com os nomes dos campos da tela HTML e os seus respectivos valores atuais.
returnroot	JSonObject	Contêm um JSonObject com que será retornado para o HTML e que poderá ser customizado na UPC. Tudo que for customizado deverá estar dentro desta tag.

...

Bloco de código

title	JSon recebido na UPC para Validação do Formulário
linenumbers	true
collapse	true

{ 
    property: 'codAcao',
    originalValues: {
        "codIdiomPadr": "01 Português",
        "codIdioma": "12345678",
        "desIdioma": "12345678901234567890",
        "hraUltAtualiz": "",
        "datUltAtualiz": null,
        "id": 6,
        "codAcoes": "FocoDesIdioma"
    },
    returnroot: {
        value: {
            desIdioma: 'teste de escrita',
            hraUltAtualiz: '17:18:19'
        },
        fields: [
            {
                property: 'codCpfCnpj', 
                mask: '99.999.999/9999-99' 
            }
        ],
        focus: 'hraUltAtualiz',
        _messages: [ 
            { 
                code: '01', 
                message: 'Mensagem do erro que aconteceu', 
                detailedMessage: 'detalhes do erro acontecido' 
            } 
        ]
    }
}

07. FACILITADORES PROGRESS

Criamos facilitadores para auxiliar no desenvolvimento das API's, ficam localizados na classe Progress "com.totvs.framework.api.JsonAPIUtils":

Após a customização pela UPC, sera devolvido para a API Rest apenas a tag root, com as customizações necessárias, conforme o exemplo abaixo onde temos o resultado de uma customização:

Bloco de código

title	JSon retornado pela UPC para Validações
linenumbers	true
collapse	true

{
    "_messages": [
        {
            "detailedMessage": "Na execução da UPC, houveram alterações nos campos de tela.",
            "code": "44",
            "message": "A UPC alterou algumas caracteristica da tela."
        }
    ],
    "focus": "desIdioma",
    "fields": [
        {
            "property": "codIdiomPadr",
            "disabled": true
        }
    ],
    "value": {
        "desIdioma": "Valor customizado na UPC"
    }
}

07. FACILITADORES PROGRESS

Criamos facilitadores para auxiliar no desenvolvimento das API's, ficam localizados na classe Progress "com.totvs.framework.api.JsonAPIUtils":

Método	Descrição	Assinatura/Exemplo
convertAblTypeToHtmlType	Converte os tipos nativos do Progress para os tipos esperados pelo PO-UI	Assinatura: convertAblTypeToHtmlType (INPUT cType AS CHARACTER) Exemplo: ASSIGN cType = JsonAPIUtils:convertAblTypeToHtmlType ("integer"). O retorno no cType será "number",
Método	Descrição	Assinatura/Exemplo
convertAblTypeToHtmlType	Converte os tipos nativos do Progress para os tipos esperados pelo PO-UI	Assinatura: convertAblTypeToHtmlType (INPUT cType AS CHARACTER) Exemplo: ASSIGN cType = JsonAPIUtils:convertAblTypeToHtmlType ("integer"). O retorno no cType será "number", que é um formato reconhecido pelo PO-UI.
convertToCamelCase	Converter os nomes dos campos lidos da tabela, normalmente com "_", para "camel case", que é o mais comum utilizado em Json's.	Assinatura: convertToCamelCase (INPUT cKey AS CHARACTER) Exemplo: ASSIGN cField= JsonAPIUtils:convertToCamelCase ("cod_e_mail_usuar"). O retorno no cField será "codEMailUsuar", que é o campo em Camel Case.
getIdField	Retorna um campo do tipo ID para ser adicionado na lista de campos do Metadata. Este campo serve como chave do registro nos tratamentos de CRUD na parte HTML.	Assinatura: getIdField() Exemplo: oIdiomas:add( JsonAPIUtils:getIdField() ).

...

Esta apresentação trata-se de um MVP e poderá ser evoluída nas próximas Sprints.

Com a parte de validação do formulário é possível tratar e validar os campos de acordo cum a lógica de negócio que ocorre no back-end.

HTML

<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>

Árvore de páginas

Versões comparadas

Versão antiga 83

Nova versão 84

Chave

JSon que teremos que retornar para

a tela HTML

07. FACILITADORES PROGRESS

07. FACILITADORES PROGRESS