Histórico da Página

setPageTitle ( pCodTitle )

Parâmetros:

• pCodTitle (CHARACTER): Novo Titulo da Página.

Retorno (LOGICAL): Indicativo se foi possível alterar o Título.

// Altera o Título da Página

oCustPages:setPageTitle(oCustPages:getPageTitle() + " - ALTERADO"Clientes Prime").

getPageTitle ( )

Retorno (CHARACTER): Título da Página.

//ASSIGN AlteravTitulo o Título da Página= oCustPages:setPageTitle(oCustPages:getPageTitle() + " - ALTERADO")..
... Faz algo com o título

setPageProperty ( pCodProperty , pCodValue )

Parâmetros:

• pCodProperty (CHARACTER): Propriedade que deve ser alterada;
• pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor.

Retorno (LOGICAL): Indicativo se foi possível alterar a Propriedade.

oCustPages:setPageProperty("keepfilters", TRUE).

getPagePropertyCharacter ( pCodProperty )

getPagePropertyInteger ( pCodProperty )

getPagePropertyDecimal ( pCodProperty )

getPagePropertyLogical ( pCodProperty )

Parâmetros:

• pCodProperty (CHARACTER): Propriedade.

Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade.

ASSIGN vConctFilter =
  oCustPages:getPagePropertyLogical("concatFilters").
... Faz algo com a informação

setFieldLabel ( pCodField , pCodLabel [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributocampo;
• pCodLabel (CHARACTER): Novo label do atributocampo;
• pGroupId (CHARACTER): Agrupador onde o atributo campo está contido. Se É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (LOGICAL): Indicativo se foi possível alterar o Label.

Exemplo1:
oCustFields:setFieldLabel("enableFIFOInPurchaseReq", 
                                       // Altera o label da coluna "FIFO" para "FIFO-ALT").

Exemplo2:
oCustFields:setFieldLabel("enableFIFOInPurchaseReqconsistsUnitPrice", 
                      "Consistir preço único",
               "FIFO-ALT    "fieldsTypingValidations").

setDisableField ( pCodField [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributocampo;
• pGroupId (CHARACTER): Agrupador onde o atributo campo está contido. Se É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (LOGICAL): Indicativo se foi possível desabilitar o atributocampo.

Exemplo1:
oCustFields:setDisableField("variationIssuing").

Exemplo2:
oCustFields:setDisableField("updatesWithDuplicateError", 
             

// Desabilita o campo "Atualizar com erro de duplicata" 
// (Aba: Atualização recebimento fiscal)

oCustFields:setDisableField("updatesWithDuplicateError", 
                            "fieldsUpdateFiscalConfigurations").

setEnableField ( pCodField [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributocampo;
• pGroupId (CHARACTER): Agrupador onde o atributo campo está contido. Se É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (LOGICAL): Indicativo se foi possível habilitar o atributocampo.

Exemplo1:
oCustFields:setEnableField("acceptableTaxDifference").

Exemplo2:// Habilita o campo "Unidade negócio" (Aba: Digitação/Geração)
oCustFields:setEnableField("enableBusinessUnit", 
                           "fieldsTypingEnableDisable").

setHideField ( pCodField [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributocampo;
• pGroupId (CHARACTER): Agrupador onde o atributo campo está contido. Se É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (LOGICAL): Indicativo se foi possível esconder o atributocampo.

Exemplo1:
oCustFields:setHideField("itemDiscount").

Exemplo2:// Esconde o campo "Desconto item"
oCustFields:setHideField("itemDiscountdefaultSpeciesExpenses",
                        "fieldsTypingDuplicates").

setShowField ( pCodField [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributocampo;
• pGroupId (CHARACTER): Agrupador onde o atributo campo está contido. Se É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (LOGICAL): Indicativo se foi possível apresentar o atributocampo.

Exemplo1:
oCustFields:setShowField("creditNoteGeneration").

Exemplo2:
oCustFields:setShowField("receiveWithoutOrder",
                         "fieldsTypingOrders"

// Mostra o campo "Geração nota crédito a pagar"

oCustFields:setShowField("creditNoteGeneration").

setFieldProperty ( pCodField , pCodProperty , pCodValue [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributocampo;
• pCodProperty (CHARACTER): Propriedade que deve ser alterada;
• pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor;
• pGroupId (CHARACTER): Agrupador onde o atributo campo está contido. Se É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (LOGICAL): Indicativo se foi possível alterar a propriedade.

Exemplo1:
oCustFields:setFieldProperty("itemDiscount

// Para o campo "Sequência dos itens" mostrar "Ligado/Desligado" 
//ao invés de "Ativado/Desativado"

IF oCustFields:getFieldPropertyCharacter("enableSequence",
                                         "type"required", 
                                         "fieldsTypingEnableDisable") 
   = "boolean" THEN DOTRUE).

Exemplo2:
oCustFields:setFieldProperty("enableSequence",
                                "booleanTrue",
                             "Ligado",
        "Ligado",
                      "fieldsTypingEnableDisable").

oCustFields:setFieldProperty("enableSequence",
                             "booleanFalse",
                             "Desligado",
                             "fieldsTypingEnableDisable").

END.

getFieldPropertyCharacter ( pCodField , pCodProperty [ , getFieldPropertyCharacter ( pCodField , pCodProperty [ , pGroupId ] )

getFieldPropertyInteger ( pCodField , pCodProperty [ , pGroupId ] )

getFieldPropertyDecimal ( pCodField , pCodProperty [ , pGroupId ] )

getFieldPropertyLogical ( pCodField , pCodProperty [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributocampo;
• pCodProperty (CHARACTER): Propriedade;
• pGroupId (CHARACTER): Agrupador onde o atributo campo está contido. Se É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade.

Exemplo1:
//ASSIGN ParavOrder o=
 campo "Sequência dos itens" mostrar "Ligado/Desligado" 
//ao invés de "Ativado/Desativado"IF oCustFields:getFieldPropertyCharacter("enableSequence",
oCustFields:getFieldPropertyInteger("defaultDuplic",
                                             "order").
... Faz algo com a informação

Exemplo2:
ASSIGN vType =
  oCustFields:getFieldPropertyCharacter("typeenableSequence",
                                          "fieldsTypingEnableDisable")
     = "boolean" THEN DO:oCustFields:setFieldProperty("enableSequence"type",
                             "booleanTruefieldsTypingEnableDisable",).
... Faz algo com a informação

getFields ( [ pGroupId ] )

Parâmetros:

• pGroupId (CHARACTER): Agrupador onde o campo está contido. É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (JsonArray): Lista de campos.

Exemplo1:
DEF VAR oFields AS JsonArray NO-UNDO.
ASSIGN oFields = oCustFields:getFields().
IF oFields <> ? AND oFields:LENGTH > 10 THEN ...

Exemplo2:
DEF VAR oFields AS JsonArray NO-UNDO.
ASSIGN oFields = oCustFields:getFields("fieldsTax").
IF oFields <> ? AND oFields:LENGTH <> 0 THEN ...

getField ( pCodField [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do campo;
• pGroupId (CHARACTER): Agrupador onde o campo está contido. É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (JsonObject): Um campo.

Exemplo1:
DEF VAR oField AS JsonObject NO-UNDO.
oField = oCustFields:getField("totalTax", 
   "Ligado",
                             "fieldsTypingEnableDisable").oCustFields:setFieldProperty("enableSequence",
                             "booleanFalse",
                             "Desligado",
                             "fieldsTypingEnableDisable").

END.

"fieldsTax").
IF oField <> ? THEN
   oField:ADD("allowColumnsManager", TRUE).

Exemplo2:
DEF VAR oField AS JsonObject NO-UNDO.
oField = oCustFields:getField("enableAutomaticDuplicate").
IF oField <> ? THEN
   oField:SET("order", 10).

addField ( pCodField , pCodLabel , pCodType [ , pPosition ] [ , getFields ( [ pGroupId ] )

Parâmetros:

• pGroupId (CHARACTER): Agrupador onde o atributo está contido. Se não for informado, será considerado o agrupador padrão "fields".

Retorno (JsonArray): Lista de Atributos.

• pCodField (CHARACTER): Código do campo;
• pCodLabel (CHARACTER): Label do campo;
• pCodType (CHARACTER): Tipo do campo (usar a classe FieldType, ex: FieldType:STRING);
• pPosition: Posição onde o campo irá ficar no Formulário, usar uma da opções:
  • pIsFirst (LOGICAL): O campo será o Primeiro do Formulário (valor: YES) ou o Útimo (valor: NO);
  • pReferenceField (CHARACTER): Código de um campo já existente, onde o campo ficará DEPOIS dele.
  • É opcional, se não informado valor, o campo será o Último do Formulário.
• pGroupId (CHARACTER): Agrupador onde o campo está contido. É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (JsonObject): campo Incluído.

Exemplo1:
ASSIGN oField = oCustFields:addField("userCopy",
                                "Cópia Usuário",
 

// Pegua a quantidades de campos do agrupador "Impostos" e joga 
// no label do campo "Total"

ASSIGN oFields = oCustFields:getFields("fieldsTax")

oField  = oCustFields:getField("totalTax",
                             FieldType:STRING).

Exemplo2:
ASSIGN oField = oCustFields:addField("fieldsTaxcodeTax").

IF oFields <> ? AND oField <> ? THEN

oField:SET("label", "Total (" + string(oFields:LENGTH) + ")").

getField ( pCodField [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;
• pGroupId (CHARACTER): Agrupador onde o atributo está contido. Se não for informado, será considerado o agrupador padrão "fields".

Retorno (JsonObject): Um atributo.

,
                              "Código Imposto",
                              FieldType:NUMBER,

// Pegua a quantidades de campos do agrupador "Impostos" e joga 
// no label do campo "Total"

ASSIGN oFields = oCustFields:getFields("fieldsTax")

oField  = oCustFields:getField("totalTax", 
                               "fieldsTax").IF oFields <> ? AND   oField <> ? THEN

oField:SET("label", "Total (" + string(oFields:LENGTH) + ")").

 TRUE).

Exemplo3:
ASSIGN oField = oCustFields:addField("datAdmin",
                                "Data Admissão",
                                 FieldType:DATE,
                               "enableSequence",
                   "fieldsTypingEnableDisable").

changeFieldOrder ( pCodField [ , pPosition ] [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do campo

addField ( pCodField , pCodLabel , pCodType [ , pPosition ] [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do Atributo;
• pCodLabel (CHARACTER): Label do Atributo;
• pCodType (CHARACTER): Tipo do Atributo (usar a classe FieldType, ex: FieldType:STRING);
• pPosition: Posição onde o campo irá ficar no Formulário, usar uma da opções:
  • pIsFirst (LOGICAL): O Atributo campo será o Primeiro do Formulário (valor: YES) ou o Útimo (valor: NO);
  • pReferenceField (CHARACTER): Código de um Atributo campo já existente, onde o atributo campo ficará DEPOIS dele;
  • Se É opcional, se não informado valor, o atributo campo será o Último do Formulário.
• pGroupId (CHARACTER): Agrupador onde o atributo campo está contido. Se É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (JsonObjectLOGICAL): Atributo IncluídoIndicativo se foi possível alterar a ordem.

Exemplo1:
oCustFields:changeFieldOrder("name").

Exemplo2:
oCustFields:changeFieldOrder("cpf

// Inclui uma coluna chamada: "Cópia Usuário"

ASSIGN oField = oCustFields:addField("userCopy",
                                     "Cópia UsuárioTRUE).

Exemplo3:
oCustFields:changeFieldOrder("enableState",
                     "enableStockMovement",
                FieldType:STRING).

// Inclui a nova coluna no Gerenciador de Colunas

IF oField <> ? THEN

oField:ADD("allowColumnsManager", 
           TRUE).

"fieldsTypingEnableDisable").

setFieldValidate ( pCodField , pCodProg [ , pGroupId ] )

setFieldValidateCustom ( pCodField , pEndpoint changeFieldOrder ( pCodField [ , pPosition ] [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do Atributocampo;pPosition: Posição onde o campo irá ficar no Formulário, usar uma da opções:
• pIsFirst (LOGICAL): O Atributo será o Primeiro do Formulário (valor: YES) ou o Útimo (valor: NO);
• pReferenceField (CHARACTER): Código de um Atributo já existente, onde o atributo ficará DEPOIS dele;
Se não informado valor, o atributo será o Último do Formulário.
• pCodProg (CHARACTER): API-REST de Produto (deve ser enviado o terceiro parâmetro recebido pela UPC). Quando o campo for alterado, será executado o Endpoint 'validateField' da API-REST do Produto;
• pEndpoint (CHARACTER): Endpoint (método POST) que será executado quando o campo for alterado. O caminho do Endpoint pode ser relativo (API-REST dentro do datasul) ou completo;
• pGroupId (CHARACTER): Agrupador onde o atributo campo está contido. Se É opcional, se não for informado, será considerado o agrupador padrão "fields".

Retorno (LOGICAL): Indicativo se foi possível alterar incluir a ordempropriedade no campo.

Exemplo1:
oCustFields:setFieldValidate("allowedVariation// Colocar o Campo "Estado (UF)" depois do campo "Baixa estoque"
oCustFields:changeFieldOrder("enableState",
                             "enableStockMovement").// Coloca o campo "CPF" como sendo o primeiro campo do Formulário
oCustFields:changeFieldOrder("cpf",
             pAPI).

Exemplo2:
oCustFields:setFieldValidate("execGZIPProgram",
                                          pAPI,
                 "fieldsTypingConfigurations").

Exemplo3:
oCustFields:setFieldValidateCustom("receiveVendorOrder",
                               YES"/api/cdpcus/v1/orders").

Exemplo4:
oCustFields:setFieldValidateCustom("oderNumber",
    "http://server:3000/vdlOrder/validateField",
               "fieldsUpdateFiscalValidations").

addValidateFields ( pCodField

setFieldValidate ( pCodField , pCodProg [ , pGroupId ] )

setFieldValidateCustom ( pCodField , pEndpoint [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;campo.pCodProg

Retorno (LOGICAL): Lógico indicativo se foi possível incluir o campo.

Inclui um campo no ValidateFields do Formulário (evento validateForm).

Observação: Utilizar este método para telas HTML que implementam o componente DynamicForm.

oCustFields:addValidateFields("enableICMSTaxationCode").

isChangedField ( pCodField )

Parâmetros:

• pCodField (CHARACTER): Código do campo.
CHARACTER): API-REST de Produto (deve ser enviado o terceiro parâmetro recebido pela UPC). Quando o atributo for alterado, será executado o Endpoint 'validateField' da API-REST do Produto;
• pEndpoint (CHARACTER): Endpoint (método POST) que será executado quando o atributo for alterado. O caminho do Endpoint pode ser relativo (API-REST dentro do datasul) ou completo;
• pGroupId (CHARACTER): Agrupador onde o atributo está contido. Se não for informado, será considerado o agrupador padrão "fields".

Retorno (LOGICAL): Indicativo se foi possível incluir a propriedade no atributo.

Lógico indicativo se o campo teve seu valor alterado.

IF oCustFields:isChangedField("enableICMSTaxationCode")
THEN DO:
   ... Realiza algum tratamento
END.

getReturnRoot ( )

Retorno (JsonObject): Root de retorno.

DEFINE VARIABLE oRoot AS JsonObject NO-UNDO.
oRoot = oCustFields:getReturnRoot().
... Faz algo com a informação

getFieldValueCharacter ( pCodField )

getFieldValueInteger ( pCodField )

getFieldValueDecimal ( pCodField )

getFieldValueLogical ( pCodField )

getFieldValueDate ( pCodField )

getFieldValueJsonObject ( pCodField )

getFieldValueJsonArray

// Indica que, ao alterar o campo "Caminho completo do executável GZIP",
// deverá chamar o validateField da API-REST do Produto (Aba: Configurações)
oCustFields:setFieldValidate("execGZIPProgram",
                             pAPI,
                             "fieldsTypingConfigurations").

addValidateFields ( pCodField )

Parâmetros:

• pCodField (CHARACTER): Código do atributo. Se não for informado, será considerado o agrupador padrão "fields"campo.

Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Lógico indicativo se foi possível incluir o atributo.

Inclui um Atributo no ValidateFields do Formulário (evento validateForm).

Observação: Utilizar este método para tela que implementam o componente DynamicForm.

// Indica que, ao alterar o campo "Código tributação ICMS", 
// deverá chamar o validateForm da API-REST do Produto 
// (Aba: Digitação/Geração)

oCustFields:addValidateFields("enableICMSTaxationCode").

,DATE,JsonObject,JsonArray): Valor do campo.

Exemplo1:
ASSIGN vValorAtual =
  oCustFields:getFieldValueCharacter("execGZIPProgram").
... Faz algo com a informação

Exemplo2:
ASSIGN vValorMark =
  oCustFields:getFieldValueLogical("enableICMSTaxCode").
... Faz algo com a informação

setFieldValue ( pCodField , pCodValue isChangedField ( pCodField )

Parâmetros:

• pCodField (CHARACTER): Código do atributo.campo;
• pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL,DATE): Novo valor.

Retorno (Retorno (LOGICAL): Lógico indicativo Indicativo se o atributo teve seu valor alterado.

foi possível alterar o campo.

Exemplo1:
oCustFields:setFieldValue("execGZIPProgram",
                               vValorAjust).

Exemplo2:
oCustFields:setFieldValue("variationIssuing"

// Se alterar o campo “Código tributação ICMS” (Aba: Digitação/Geração): 
// - Se "sim": desabilita o campo “Percentual redução ICMS” e muda o 
campo "Alíquota ICMS" para "sim", 
// - Se "não": faz ao contrário
IF oCustFields:isChangedField("enableICMSTaxationCode") THEN DO:

ASSIGN vValorMark = oCustFields:getFieldValueLogical("enableICMSTaxationCode").

IF vValorMark <> ? THEN DO:
oCustFields:setFieldProperty("enableICMSReductionPercentage",
                             "disabled", 
          888).

getFieldValues ( )

Retorno (JsonObject): Valores do registro.

DEFINE VARIABLE oValues AS JsonObject NO-UNDO.
oValues = oCustFields:getFieldValues().
... Faz algo com         vValorMark).

oCustFields:setFieldValue("enableICMSRate",
                          vValorMark).
END.
END.

// Se alterar o campo "Caminho completo do executável GZIP" 
// (Aba: Digitação/Geração):
// - Muda o conteúdo para minísculo
// - Retira os acentos
// - Se retirar os acentos, muda o label para 
"Caminho completo do executável GZIP (AJUST)"
IF oCustFields:isChangedField("execGZIPProgram") THEN DO:

ASSIGN vValorAtual = oCustFields:getFieldValueCharacter("execGZIPProgram").

IF vValorAtual <> ? THEN DO:
ASSIGN vValorAjust = LC(vValorAtual)
vValorAjust = REPLACE(vValorAjust, "á", "a")
vValorAjust = REPLACE(vValorAjust, "é", "e")
vValorAjust = REPLACE(vValorAjust, "í", "i")
vValorAjust = REPLACE(vValorAjust, "ó", "o")
vValorAjust = REPLACE(vValorAjust, "ú", "u")
vValorAjust = REPLACE(vValorAjust, "ã", "a")
vValorAjust = REPLACE(vValorAjust, "õ", "o")
vValorAjust = REPLACE(vValorAjust, "ç", "c").

oCustFields:setFieldValue("execGZIPProgram",
                          vValorAjust).

IF NOT vValorAjust MATCHES(vValorAtual) THEN
oCustFields:setFieldLabel("execGZIPProgram",
                          "Caminho completo do executável GZIP (AJUST)").
ELSE
oCustFields:setFieldLabel("execGZIPProgram",
                          "Caminho completo do executável GZIP").
END.
END.

getReturnRoot ( )

Retorno (JsonObject): Root de retorno.

getFieldValueCharacter ( pCodField )

getFieldValueInteger ( pCodField )

getFieldValueDecimal ( pCodField )

getFieldValueLogical ( pCodField )

getFieldValueDate ( pCodField )

getFieldValueJsonObject ( pCodField )

getFieldValueJsonArray ( pCodField )

Parâmetros:

• pCodField (CHARACTER): Código do atributo.

Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL,DATE,JsonObject,JsonArray): Valor do atributo.

a informação

setAction ( pCodAction , pCodValue )

Parâmetros:

• pCodAction (CHARACTER): Código da Ação;
• pCodValue: Valor da Ação, usar uma das opções:
  • pCodURL (CHARACTER): Valor da URL a ser executada pela Ação;
  • pCodValue (LOGICAL): Valor da Ação.

Retorno (LOGICAL): Indicativo se foi possível incluir/alterar a Ação.

Exemplo1:
oCustActions:setAction("detail",
  "/userParameters/newdet/:id").

Exemplo2:
oCustActions:setAction("remove",
                         FALSE).

getActionCharacter ( pCodAction )

getActionLogical ( pCodAction )

Parâmetros:

• pCodAction (CHARACTER): Código da Ação.

Retorno (CHARACTER,LOGICAL): Valor da Ação.

Exemplo1:
ASSIGN 

vUrlEdit = 
  oCustActions:getActionCharacter("edit").
... Faz algo com a informação

Exemplo2:
ASSIGN vRemove = 
  oCustActions:getActionLogical("remove").

..

. Faz algo com a informação

removeAction ( pCodAction

)

Parâmetros:

• pCodAction (CHARACTER): Código

• da Ação.

Retorno (LOGICAL): Indicativo se foi possível

remover a Ação.

oCustActions:removeAction("duplicate").

getActions ( )

Retorno (JsonObject): Ações padrões.

DEFINE VARIABLE oActions AS JsonObject NO-UNDO.
oActions = oCustActions:getActions().
... Faz algo com a informação

setPageCustomActionProperty ( pIdAction , pCodProperty , pCodValue )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.
• pCodProperty (CHARACTER): Propriedade que deve ser alterada;
• pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor.

Retorno (LOGICAL): Indicativo se foi possível alterar a propriedade.

Exemplo1:
oCustActions:setPageCustomActionProperty("Atz Dados",

"icon",
                  "po-icon po-icon po-icon-refresh").

Exemplo2:
oCustActions:setPageCustomActionProperty(2,
                                 "visible",
                                    FALSE).

getPageCustomActionPropertyCharacter ( pIdAction , pCodProperty )

getPageCustomActionPropertyInteger ( pIdAction , pCodProperty )

getPageCustomActionPropertyDecimal ( pIdAction , pCodProperty )

getPageCustomActionPropertyLogical ( pIdAction , pCodProperty )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.
• pCodProperty (CHARACTER): Propriedade.

Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade.

Exemplo1:
ASSIGN vURL = 
  oCustActions:getPageCustomActionPropertyCharacter("Docto

",
                          

               "url").
... Faz algo com a informação

Exemplo2:
ASSIGN vVisible =
  oCustActions:getPageCustomActionPropertyLogical(1,
                          

getFieldValues ( )

Retorno (JsonObject): Valores do registro.

               "visible").
... Faz algo com a informação

getPageCustomAction ( pIdAction

)

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:

• • pCodLabel (CHARACTER):

• • Label da

• • Ação;

• • pNumIndex (

• • INTEGER):

• • Posição da Ação dentro da Lista de Ações.

Retorno (

JsonObject):

Uma Ação Customizada de Página.

Exemplo1:
DEF VAR oPageCustomAction AS JsonObject NO-UNDO.
oPageCustomAction = oCustActions:getPageCustomAction("Docto").
IF oPageCustomAction <> ? THEN
   oPageCustomAction:set("action",

getActionCharacter ( pCodAction )

getActionLogical ( pCodAction )

Parâmetros:

• pCodAction (CHARACTER): Código da Ação.

Retorno (CHARACTER,LOGICAL): Valor da Ação.

// Faz a Ação Padrão de Visualizar abrir a tela de Edição

oCustActions:setAction("detail"http://server:8080/doc").

Exemplo2:
DEF VAR oPageCustomAction AS JsonObject NO-UNDO.
oPageCustomAction = oCustActions:getPageCustomAction(1).
IF oPageCustomAction <> ? THEN
   oPageCustomAction:set("visible",
                       oCustActions:getActionCharacter("edit")).

removeAction ( pCodAction )

Parâmetros:

• pCodAction (CHARACTER): Código da Ação.

Retorno (LOGICAL): Indicativo se foi possível remover a Ação.

// Retira a Ação Padrão de "Cópia" da Tabela

oCustActions:removeAction("duplicate").

getActions ( )

Retorno (JsonObject): Ações padrões.

 FALSE).

addPageCustomAction ( pNumType , pCodLabel , pCodAddress [ , pCodIcon ] setPageCustomActionProperty ( pIdAction , pCodProperty , pCodValue )

Parâmetros:

• pIdActionpNumType: Identificador Tipo da Ação, usar uma das opções:
  • CustomActions:TYPE_ENDPOINT - para chamada ao BackEnd;
  • CustomActions:TYPE_ROUTE - para chamada de uma Rota (URL).
• pCodLabel (CHARACTER): Label da Ação;pNumIndex
• pCodAddress (INTEGERCHARACTER): Posição Endereço da Ação dentro da Lista de Ações.
• pCodProperty (CHARACTER): Propriedade que deve ser alterada;
• que será executada;
• pCodIcon (CHARACTER): Ícone da Ação, é opcionalpCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor.

Retorno (LOGICALJsonObject): Indicativo se foi possível alterar a propriedadeAção Customizada de Página Incluída.

Exemplo1:
oCustActions:addPageCustomAction(CustomActions:TYPE_ENDPOINT, 
                                                // Inclui o icone de Refresh na Ação Customizada "Atz Dados" da Pagina,
                            "http://server01:3000/atzDados").

Exemplo2:
oCustActions:setPageCustomActionProperty("Atz Dados",
addPageCustomAction(CustomActions:TYPE_ROUTE,
                                                 "iconGoogle",
                                  "http://www.google.com",
                        "po-icon po-icon po-icondevice-refreshdesktop").

getPageCustomActionPropertyCharacter ( pIdAction , pCodProperty )

getPageCustomActionPropertyInteger removePageCustomAction ( pIdAction , pCodProperty )

getPageCustomActionPropertyDecimal ( pIdAction , pCodProperty )

getPageCustomActionPropertyLogical ( pIdAction , pCodProperty )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.
• pCodProperty (CHARACTER): Propriedade.

Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade.Indicativo se foi possível remover a Ação.

getPageCustomAction ( pIdAction )

Exemplo1:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.

Retorno (JsonObject): Uma Ação Customizada de Página.

oCustActions:removePageCustomAction("Doctos").

Exemplo2:
oCustActions:removePageCustomAction(3).

getPageCustomActions ( )

Retorno (JsonArray): Ações Customizadas de Página.

DEFINE VARIABLE oPageCustomActions AS JsonArray NO-UNDO.
oPageCustomActions

// Altera o Endereço da primeira Ação Customizada da Pagina

oAction = oCustActions:getPageCustomActiongetPageCustomActions(1).
IF... oActionFaz <> ? THEN

oAction:set("action", 
            "http://newserver:8080/customer").

algo com a informação

setTableCustomActionProperty ( pIdAction , pCodProperty , pCodValue addPageCustomAction ( pNumType , pCodLabel , pCodAddress [ , pCodIcon ] )

Parâmetros:

• pNumTypepIdAction: Tipo Identificador da Ação, usar uma das opções:
  • CustomActions:TYPE_ENDPOINT - para chamada ao BackEnd;
  • CustomActions:TYPE_ROUTE - para chamada de uma Rota (URL).
  • pCodLabel (CHARACTER): Label da Ação;
  pCodAddress
  • pNumIndex (
  CHARACTER
  • INTEGER):
  Endereço
  • Posição da Ação
  que será executada
  • dentro da Lista de Ações.
• pCodProperty (CHARACTER): Propriedade que deve ser alterada;
• pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor;pCodIcon (CHARACTER): Ícone da Ação.

Retorno (JsonObjectLOGICAL): Indicativo se foi possível alterar a propriedade.

Exemplo1:
oCustActions:setTableCustomActionProperty("Atz Dados",
                              // Inclui uma nova Ação Customizada no Pagina chamada "Atz Dados" que chama
// uma EndPoint
oCustActions:addPageCustomAction(CustomActions:TYPE_ENDPOINT, 
                 "icon",
                "Atz Dados"   "po-icon po-icon po-icon-refresh").

Exemplo2:
oCustActions:setTableCustomActionProperty(2,
                                 "http://server01:3000/atzDados").// Inclui uma nova Ação Customizada no Pagina chamada "Google" que chama uma
// Rota
oCustActions:addPageCustomAction(CustomActions:TYPE_ROUTE,
 "visible",
                                     FALSE).

getTableCustomActionPropertyCharacter ( pIdAction , pCodProperty )

getTableCustomActionPropertyInteger ( pIdAction , pCodProperty )

getTableCustomActionPropertyDecimal ( pIdAction , pCodProperty )

getTableCustomActionPropertyLogical ( pIdAction , pCodProperty )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.
• pCodProperty: Propriedade.

Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade.

Exemplo1:
ASSIGN vURL = 
              "GoogleoCustActions:getTableCustomActionPropertyCharacter("Docto",
                                 "http://www.google.com",
                                 "po-icon po-icon-device-desktop").

removePageCustomAction ( pIdAction )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.

Retorno (LOGICAL): Indicativo se foi possível remover a Ação.

// Elimina a Ação Customizada chamada "Doctos" da Pagina

oCustActions:removePageCustomAction("Doctos").

url").
... Faz algo com a informação

Exemplo2:
ASSIGN vVisible =
  oCustActions:getTableCustomActionPropertyLogical(1,
                                          "visible").
... Faz algo com a informação

getTableCustomAction ( pIdAction

getPageCustomActions ( )

Retorno (JsonArray): Ações Customizadas de Página.

setTableCustomActionProperty ( pIdAction , pCodProperty , pCodValue )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.
  pCodProperty

Retorno (

JsonObject):

Retorno (LOGICAL): Indicativo se foi possível alterar a propriedade.

Uma Ação Customizada de Tabela.

Exemplo1:
DEF VAR oTableCustomAction AS JsonObject NO-UNDO.
oTableCustomAction =
  oCustActions:getTableCustomAction("Docto").
IF oTableCustomAction <> ? THEN
   oTableCustomAction:set("action",
         "http://server:8080/doc").

Exemplo2:
DEF VAR oTableCustomAction AS JsonObject NO-UNDO.
oTableCustomAction =
  oCustActions:getTableCustomAction(1).
IF oTableCustomAction <> ? THEN
   oTableCustomAction:set("visible",
                             FALSE).

addTableCustomAction ( pNumType , pCodLabel , pCodAddress [ , pCodIcon ] [ , pConcatKeys ] )

Parâmetros:

• pNumType: Tipo

getTableCustomActionPropertyCharacter ( pIdAction , pCodProperty )

getTableCustomActionPropertyInteger ( pIdAction , pCodProperty )

getTableCustomActionPropertyDecimal ( pIdAction , pCodProperty )

getTableCustomActionPropertyLogical ( pIdAction , pCodProperty )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.
• pCodProperty: Propriedade.

Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade.

• • CustomActions:TYPE_ENDPOINT - para chamada ao BackEnd;
  • CustomActions:TYPE_ROUTE - para chamada de uma Rota (URL).
• pCodLabel (CHARACTER): Label da Ação;
• pCodAddress (CHARACTER): Endereço da Ação que será executada;
• pCodIcon (CHARACTER): Ícone da Ação, é opcional;
• pConcatKeys (LOGICAL): Indica se deve ser acrescentada a propriedade "concatKeys" na Ação, é opcional

getTableCustomAction ( pIdAction )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
• pCodLabel (CHARACTER): Label da Ação;
pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.

Retorno (JsonObject): Uma Ação Customizada de Tabela Incluída.

Exemplo1:
oCustActions:addTableCustomAction(

Parâmetros:

• pNumType: Tipo da Ação, usar uma das opções:
  • CustomActions:TYPE_ENDPOINT - para chamada ao BackEnd;
  • CustomActions:TYPE_ROUTE - para chamada de uma Rota (URL).
• pCodLabel (CHARACTER): Label da Ação;
• pCodAddress (CHARACTER): Endereço da Ação que será executada;
• pCodIcon (CHARACTER): Ícone da Ação;
• pConcatKeys (LOGICAL): Indica se deve ser acrescentada a propriedade "concatKeys" na Ação.

Retorno (JsonObject): Ação Customizada de Tabela Incluída.

CustomActions:TYPE_ENDPOINT,
                                                   "Bloqueia",
                                "http://server01:3000/block").

Exemplo2:
oCustActions:addTableCustomAction(CustomActions:TYPE_ROUTE,
                                           "Det Adicional",
               "http://newserver:8080/dts/customer/detail",
                        "po-icon po-icon po-icon-refresh").

Exemplo3:// Inclui uma nova Ação Customizada no Tabela chamada "Bloqueia" que chama
// uma EndPoint
oCustActions:addTableCustomAction(CustomActions:TYPE_ENDPOINT,
                                  "Bloqueia",
                   "Copiar",
                       "http://server01server:3000/block/dts/customer/copy",
                                             "po-icon po-icon po-icon-refresh").// Inclui uma nova Ação Customizada no Tabela chamada "Det Adicional" que
// chama uma Rota
oCustActions:addTableCustomAction(CustomActions:TYPE_ROUTE,
              "",
                                                        "Det Adicional",
                                  "http://newserver:8080/dts/customer/detail").

removeTableCustomAction ( pIdAction )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.

Retorno (LOGICAL): Indicativo se foi possível remover a Ação.

// Elimina a Ação Customizada chamada "Relacto" da Pagina

oCustActions:removeTableCustomAction("Relacto").

getTableCustomActions ( )

Retorno (JsonArray): Ações Customizadas de Tabela.

getServerAddress ( pIsExt )

Parâmetros:

• pIsExt (LOGICAL): Indica se deve ser considerado o Endereço Exerno (Valor: TRUE) ou Interno (Valor:FALSE). Se for solicitado o Externo e ele não existir, será devolvido o interno.

Retorno (CHARACTER): Endereço no formato: http://HOST:PORT.

TRUE).

removeTableCustomAction ( pIdAction )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.

Retorno (LOGICAL): Indicativo se foi possível remover a Ação.

Exemplo1:
oCustActions:removeTableCustomAction("Relacto").

Exemplo2:
oCustActions:removeTableCustomAction(2).

getTableCustomActions ( )

Retorno (JsonArray): Ações Customizadas de Tabela.

DEFINE VARIABLE oTableCustomActions AS JsonArray NO-UNDO.
oTableCustomActions = oCustActions:getTableCustomActions().
... Faz algo com a informação

getServerAddress ( pIsExt )

Parâmetros:

• pIsExt (LOGICAL): Indica se deve ser considerado o Endereço Exerno (Valor: TRUE) ou Interno (Valor:FALSE). Se for solicitado o Externo e ele não existir, será devolvido o interno.

Retorno (CHARACTER): Endereço no formato: http://HOST:PORT.

Exemplo1:
DEFINE VARIABLE vServer AS CHARACTER NO-UNDO.
ASSIGN vServer = oCustActions:getServerAddress(FALSE).
... Faz algo com a informação

Exemplo2:
DEFINE VARIABLE vServerExt AS CHARACTER NO-UNDO.
ASSIGN vServerExt = oCustActions:getServerAddress(TRUE).
... Faz algo com a informação

getEntityKeyCharacter ( )

getEntityKeyInteger ( )

Retorno (CHARACTER,INTEGER): Chave do registro.

Exemplo1:
DEFINE VARIABLE vCodPais AS CHARACTER NO-UNDO.
ASSIGN vCodPais = oCustRecords:getEntityKeyCharacter().
... Faz algo com a informação

Exemplo2:
DEFINE VARIABLE vIdCliente AS INTEGER NO-UNDO.
ASSIGN vIdCliente = oCustRecords:getEntityKeyInteger().
.. Faz algo com a informação

updateRecords ( pProg , pPiName )

Parâmetros:

• pProg (HANDLE): Handle do programa UPC;
• pPiName (CHARACTER): Nome da PI que será executada a cada registro dos dados. Ela deve receber como parâmetro um JsonObject que representa o registro, exemplo:

  DEF INPUT PARAM oItem AS JsonObject NO-UNDO.

Retorno (LOGICAL): Indicativo se é possível alterar o registro.

Navega nos registros e executa uma PI interna da UPC para customização dos dados.

// Indica que dever ser executada a PI "pi_altera_registros" para 
// realizar a alteração nos registros
oCustRecords:updateRecords(THIS-PROCEDURE, "pi_altera_registros").
// PI que será executada para cada registro da Tabela

PROCEDURE pi_altera_registros:
   DEF INPUT PARAM oItem AS JsonObject NO-UNDO.
// Atualiza a coluna "Cópia Usuário" com o valor da coluna "Usuário"
oItem:ADD("userCopy", oItem:getCharacter("userCode")).
// Altera o conteúdo da coluna "Nome", concatenado: "- Alterado"
oItem:SET("userName", oItem:getCharacter("userName") + " - Alterado"   FIND minha-tabela WHERE
        minha-tabela.cod-cliente = oItem:getCharacter("userCode")
        NO-LOCK NO-ERROR.
   IF AVAIL minha-tabela THEN
      oItem:ADD("myInform", minha-tabela.cod-minha-info).
END PROCEDURE.