Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

MétodoDescriçãoExemplo

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.

Altera o Label de um campo.
Exemplo1:
oCustFields:setFieldLabel("enableFIFOInPurchaseReq",
"FIFO-ALT").

Exemplo2:
oCustFields:setFieldLabel("consistsUnitPrice",
                         "Consistir preço único",
"fieldsTypingValidations").

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.

Desabilita um campo.
Exemplo1:
oCustFields:setDisableField("variationIssuing").

Exemplo2:
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.

Habilita um campo.
Exemplo1:
oCustFields:setEnableField("acceptableTaxDifference").

Exemplo2:
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.

Esconde um campo.
Exemplo1:
oCustFields:setHideField("itemDiscount").

Exemplo2:
oCustFields:setHideField("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.

Mostra um campo.
Exemplo1:
oCustFields:setShowField("creditNoteGeneration").

Exemplo2:
oCustFields:setShowField("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.

Altera uma propriedade de um campo.
Exemplo1:
oCustFields:setFieldProperty("itemDiscount",
"required",
TRUE).

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

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.

Retorna o valor de uma propriedade de um campo.
Exemplo1:
ASSIGN vOrder =
oCustFields:getFieldPropertyInteger("defaultSpeciesDuplic",
"order").
... Faz algo com a informação

Exemplo2:
ASSIGN vType =
oCustFields:getFieldPropertyCharacter("enableSequence",
"type",
"fieldsTypingEnableDisable").
... 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.

Retorna um JsonArray que representa a lista de campos.
Exemplo1:
DEF VAR oFields AS JsonArray NO-UNDO.
ASSIGN oFields = oCustFields:getFields().
... Faz algo com a informaçãoIF oFields <> ? AND oFields:LENGTH > 10 THEN ...

Exemplo2:
DEF VAR oFields AS JsonArray NO-UNDO.
ASSIGN oFields = oCustFields:getFields("fieldsTax").
... Faz algo com a informaçãoIF 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.

Retorna um JsonObject que representa um campo.
// Pegua a quantidades de campos do agrupador "Impostos" e joga 
// no label do campo "Total"
ASSIGN oFields = oCustFields:getFields("fieldsTax")
oField  Exemplo1:
DEF VAR oField AS JsonObject NO-UNDO.
oField = oCustFields:getField("totalTax",
"fieldsTax").
IF oFieldsoField <> ? ANDTHEN
oField <> ? THENoField:SETADD("labelallowColumnsManager", "Total (" + string(oFields:LENGTH) + ")" 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 ] [ , 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.

Incluir um novo campo.
Exemplo1:// 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

IFExemplo2:
ASSIGN oField <> ? THENoField:ADD= oCustFields:addField("allowColumnsManagercodeTax",

TRUE) "Código Imposto",
FieldType:NUMBER,
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;
  • 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.

Altera a Ordem de um campo.
Exemplo1:
oCustFields:changeFieldOrder("name").

Exemplo2:// Colocar o Campo "Estado (UF)" depois do campo "Baixa estoque"
oCustFields:changeFieldOrder("enableStatecpf",
TRUE).

Exemplo3:
oCustFields:changeFieldOrder("enableState",
"enableStockMovement").// Coloca o campo "CPF" como sendo o primeiro campo do Formulário
oCustFields:changeFieldOrder("cpf"enableStockMovement",
YES"fieldsTypingEnableDisable").

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.

Incluir a propriedade 'validate' no campo (monitora a alterado do campo - evento validateField).
Exemplo1:
oCustFields:setFieldValidate("allowedVariation",
pAPI).

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

Exemplo3:
oCustFields:setFieldValidateCustom("receiveOtherVendorOrder",
// 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 "/api/cdpcus/v1/orders").

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

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

Verifica se um campo foi alterado (eventos ValidateForm e ValidateField).
// 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.

Retorna um JsonOject que representa o Root de retorno (eventos ValidateForm e ValidateField).

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.

Retorna o valor de um 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.

Altera o valor de um 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.

Retorna um JsonOject que representa os Valores do registro.

...