Histórico da Página

CONTEÚDO

Visão Geral
1. Lado Progress
2. Lado PO-UI
Exemplo de utilização
1. Lado Progress
2. Lado HTML com PO-UI
Tela XXX
1. Outras Ações / Ações relacionadas
Tela XXX
1. Principais Campos e Parâmetros
Tabelas utilizadas

...

No PO-UI, a Form Dinâmica trabalha recebendo uma lista de campos que serão apresentados em tela, bem como uma outra lista contendo os dados que serão apresentados nestes campos.

Lado Progress

Para que possamos customizar uma tela, teremos que ter uma API REST que possa receber as informações do HTML, e esta API deverá permitir a utilização da técnica de EPC. A API REST para ser customizada, deverá ser cadastrada no cadastro de programas (MEN012AA), onde poderemos também especificar a UPC que será utilizada.

...

Preprocessador	Descrição
endpoint	Especifica o endpoint que esta sendo chamado pelo HTML. Uma API REST deve possuir 1 ou mais endpoints.
event	É o nome do evento que esta ocorrendo antes de chamar a UPC. Exemplo: beforeCreate, getAll, getMetaData, etc.
jsonVar	É a variavel variável do tipo JsonObject que será passada como INPUT-OUTPUT para a UPC.

Informações

title	IMPORTANTE

IMPORTANTE: Todas as UPCs de API REST deverão importar os seguintes pacotes:

USING PROGRESS.json.*.

USING PROGRESS.json.ObjectModel.*.

USING com.totvs.framework.api.*.

Parâmetros recebidos na UPC da API REST

Parametro	Tipo	Tipo de Dados	Descrição
pEndPoint	INPUT	CHARACTER	Contem o nome do endpoint que está sendo executado.
pEvent	INPUT	CHARACTER	Contem o nome do evento que está sendo executado.
pAPI	INPUT	CHARACTER	Contem o nome da API que está sendo executada.
jsonIO	INPUT-OUTPUT	JSONObject	Contem o JSON com os dados (campos ou valores) que poderão ser customizados.

02. EXEMPLO DE UTILIZAÇÃO

Parte Progress

Primeiramente temos que cadastrar a API REST no cadastro de programas (MEN012AA) e também especificar a UPC a ser utilizada, conforme o exemplo abaixo:

Image Added

Na aba Opções, teremos que especificar o Template como "API REST", conforme o exemplo abaixo:

Image Added

Abaixo temos um exemplo de partes de uma API REST , que possui 2 procedures, a procedure pGetAll para tratar as chamadas GET dos dados a serem apresentados e a procedure pGetMetaData que trata os GETs para a criacção criação de novos campos.

Bloco de código

title	API REST
linenumbers	true

PROCEDURE pGetAll:
    DEFINE INPUT  PARAMETER oJsonInput  AS JsonObject NO-UNDO.
    DEFINE OUTPUT PARAMETER oJsonOutput AS JsonObject NO-UNDO.

    ...
    
    oIdiomas    = JsonAPIUtils:convertTempTableToJsonArray(TEMP-TABLE ttIdiomas:HANDLE).
    oObj        = new JsonObject().
    oObj:add('root', oIdiomas).
    
    /* realiza a chamada da UPC Progress */
    {include/i-epcrest.i &endpoint=getAll &event=getAll &jsonVar=oObj}
    oIdiomas = oObj:getJsonArray('root').    

    oResponse   = NEW JsonAPIResponse(oIdiomas).
    oJsonOutput = oResponse:createJsonResponse().
    
    ...
    
END PROCEDURE.

PROCEDURE pGetMetaData:
    DEFINE INPUT  PARAMETER oJsonInput  AS JsonObject NO-UNDO.
    DEFINE OUTPUT PARAMETER oJsonOutput AS JsonObject NO-UNDO.

    ...
    
    // monsta-se a lista de campos que aparecerão em tela
    oObj        = new JsonObject().
    oObj:add('root', jAList).
    
    /* realiza a chamada da UPC Progress */
    {include/i-epcrest.i &endpoint=getMetaData &event=getMetaData &jsonVar=oObj}    
    oIdiomas = oObj:getJsonArray('root').    
    
    oResponse   = NEW JsonAPIResponse(oIdiomas).
    oJsonOutput = oResponse:createJsonResponse().
    
    ...
    
END PROCEDURE.

Abaixo temos um exemplo de uma UPC criada para a API REST:

Bloco de código

title	UPC da API REST

Exemplo de UPC de API REST:
    DEFINE INPUT        PARAMETER pEndPoint AS CHARACTER  NO-UNDO.
    DEFINE INPUT        PARAMETER pEvent    AS CHARACTER  NO-UNDO.
    DEFINE INPUT        PARAMETER pAPI      AS CHARACTER  NO-UNDO.
    DEFINE INPUT-OUTPUT PARAMETER jsonIO    AS JSONObject NO-UNDO.

03. TELA XXXXX

Outras Ações / Ações relacionadas

...

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão 5

Chave