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.

oCustPages:setPageTitle("Clientes Prime").

getPageTitle ( )

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

ASSIGN vTitulo = oCustPages:getPageTitle().
... 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 campo;
• pCodLabel (CHARACTER): Novo label do campo;
• pGroupId (CHARACTER): Agrupador onde o campo está contido. É 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-ALTfieldsTypingValidations").

setDisableField ( 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 (LOGICAL): Indicativo se foi possível desabilitar o campo.

Exemplo1:
oCustFields:setDisableField("variationIssuing").

Exemplo2:// 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 campo;
• pGroupId (CHARACTER): Agrupador onde o campo está contido. É opcional, se não for informado, será considerado o agrupador padrão "fields".

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

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 campo;
• pGroupId (CHARACTER): Agrupador onde o campo está contido. É opcional, se não for informado, será considerado o agrupador padrão "fields".

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

Exemplo1:
oCustFields:setHideField("itemDiscount").

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

setShowField ( 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 (LOGICAL): Indicativo se foi possível apresentar o campo.

Exemplo1:
oCustFields:setShowField("creditNoteGeneration").

Exemplo2:// Mostra o campo "Geração nota crédito a pagar"
oCustFields:setShowField("creditNoteGeneration"receiveWithoutOrder",
                         "fieldsTypingOrders").

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

Parâmetros:

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

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

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

IF oCustFields:getFieldPropertyCharacter("enableSequence",
Exemplo1:
oCustFields:setFieldProperty("itemDiscount",
                             "required",
                             "typeTRUE).

Exemplo2:
oCustFields:setFieldProperty("enableSequence", 
                             "booleanTrue",
            "fieldsTypingEnableDisable") 
   = "boolean" THEN DO:oCustFields:setFieldProperty("enableSequence",
                             "booleanTrueLigado",
                              "Ligado",
                             "fieldsTypingEnableDisable").

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

END.

getFieldPropertyCharacter ( pCodField , pCodProperty [ , pGroupId ] )

getFieldPropertyInteger ( pCodField , pCodProperty [ , pGroupId ] )

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

getFieldPropertyInteger ( pCodField , pCodProperty [ , pGroupId ] )

getFieldPropertyDecimal ( pCodField , pCodProperty [ , pGroupId ] )

getFieldPropertyLogical ( pCodField , pCodProperty [ , pGroupId ] )

Parâmetros:

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

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

• será considerado o agrupador padrão "fields".

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

Exemplo1:
ASSIGN vOrder =
  oCustFields:getFieldPropertyInteger("defaultSpeciesDuplic

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

IF oCustFields:getFieldPropertyCharacter("enableSequence",
                                         "type",
                                         "fieldsTypingEnableDisable")
   = "boolean" THEN DO:

oCustFields:setFieldProperty("enableSequence",
                             "booleanTrue",
                             "Ligado",
                             "fieldsTypingEnableDisable").oCustFields:setFieldProperty"order").
... Faz algo com a informação

Exemplo2:
ASSIGN vType =
  oCustFields:getFieldPropertyCharacter("enableSequence",
                             "booleanFalse",
              "type",
               "Desligado",
                             "fieldsTypingEnableDisable").
END.... 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().
... Faz algo com a informação

Exemplo2:
DEF VAR oFields AS JsonArray NO-UNDO.
ASSIGN oFields = oCustFields:getFields("fieldsTax").
... Faz algo com a informação

// 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) + ")").

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.

// 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) + ")").

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

Parâmetros:

• 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.

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

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

// Inclui a nova coluna no Gerenciador de Colunas

IF oField <> ? THEN

oField:ADD("allowColumnsManager", 
           TRUE).

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

Parâmetros:

• pCodField (CHARACTER): Código do campo;
• 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 (LOGICAL): Indicativo se foi possível alterar a ordem.

// 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",
                             YES).

setFieldValidate ( pCodField , pCodProg [ , pGroupId ] )

setFieldValidateCustom ( pCodField , pEndpoint [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do campo;
• 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 campo está contido. É opcional, se não for informado, será considerado o agrupador padrão "fields".

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

// 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 campo.

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 tela telas HTML 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").

isChangedField ( pCodField )

Parâmetros:

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

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

// 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", 
                             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 campo.

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

// 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",
                             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.

setFieldValue ( pCodField , pCodValue )

Parâmetros:

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

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

// 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",
                             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.

// Altera o valor da coluna "Variação máxima data emissão" para "888"
// (Aba: Digitação/Geração)
oCustFields:setFieldValue("variationIssuing",
                          888).

getFieldValues ( )

Retorno (JsonObject): Valores do registro.