Histórico da Página

...

------------------
CLASSE: CustomPage - Purpose: Customizações da Página
------------------

Método	Descrição	Exemplo
setPageTitle(pCodTitle) Parameters: - pCodTitle (CHARACTER): Novo Titulo da Page Retorno (LOGICAL): Indicativo se foi possível alterar o Título	- Purpose: Altera o Titulo da Page
getPageTitle() Retorno (CHARACTER): Título da Página	- Purpose: Retorna o Titulo da Page
setPageProperty(pCodProperty, pCodValue) Parameters: - pCodProperty (CHARACTER): Propriedade que deve ser alterada - pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor Retorno (LOGICAL): Indicativo se foi possível alterar a Propriedade	- Purpose: Altera uma propriedade da Tela
getPagePropertyCharacter(pCodProperty) getPagePropertyInteger(pCodProperty) getPagePropertyDecimal(pCodProperty) getPagePropertyLogical(pCodProperty) Parameters: - pCodProperty (CHARACTER): Propriedade Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade	- Purpose: Retorna o valor de uma propriedade da Tela

...

--------------------
CLASSE: CustomFields - Purpose: Customizações de Campos
--------------------

Método	Descrição	Exemplo
setFieldLabel(pCodField, pCodLabel [, pGroupId]) Parameters: - pCodField (CHARACTER): Código do atributo - pCodLabel (CHARACTER): Novo label do atributo - pGroupId (CHARACTER): Agrupador onde o atributo está contido Retorno (LOGICAL): Indicativo se foi possível alterar o Label	- Purpose: Altera o Label de um Atributo
setDisableField(pCodField [, pGroupId]) Parameters: - pCodField (CHARACTER): Código do atributo - pGroupId (CHARACTER): Agrupador onde o atributo está contido Retorno (LOGICAL): Indicativo se foi possível desabilitar o atributo	- Purpose: Desabilita um Atributo
setEnableField(pCodField [, pGroupId]) Parameters: - pCodField (CHARACTER): Código do atributo - pGroupId (CHARACTER): Agrupador onde o atributo está contido Retorno (LOGICAL): Indicativo se foi possível habilitar o atributo	- Purpose: Habilita um Atributo
setHideField(pCodField [, pGroupId]) Parameters: - pCodField (CHARACTER): Código do atributo - pGroupId (CHARACTER): Agrupador onde o atributo está contido Retorno (LOGICAL): Indicativo se foi possível esconder o atributo	- Purpose: Esconde um Atributo
setShowField(pCodField [, pGroupId]) Parameters: - pCodField (CHARACTER): Código do atributo - pGroupId (CHARACTER): Agrupador onde o atributo está contido Retorno (LOGICAL): Indicativo se foi possível apresentar o atributo	- Purpose: Mostra um Atributo
setFieldProperty(pCodField, pCodProperty, pCodValue [, pGroupId]) Parameters: - pCodField (CHARACTER): Código do atributo - pCodProperty (CHARACTER): Propriedade que deve ser alterada - pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor - pGroupId (CHARACTER): Agrupador onde o atributo está contido Retorno (LOGICAL): Indicativo se foi possível alterar a propriedade	- Purpose: Altera uma propriedade de um Atributo
getFieldPropertyCharacter(pCodField, pCodProperty [, pGroupId]) getFieldPropertyInteger(pCodField, pCodProperty [, pGroupId]) getFieldPropertyDecimal(pCodField, pCodProperty [, pGroupId]) getFieldPropertyLogical(pCodField, pCodProperty [, pGroupId]) Parameters: - pCodField (CHARACTER): Código do atributo - pCodProperty (CHARACTER): Propriedade - pGroupId (CHARACTER): Agrupador onde o atributo está contido Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade	- Purpose: Retorna o valor de uma propriedade de um Atributo
getFields([pGroupId]) Parameters: - pGroupId (CHARACTER): Agrupador onde o atributo está contido Retorno (JsonArray): Lista de Atributos	- Purpose: Retorna um JsonArray que representa a lista de Atributos
getField(pCodField [, pGroupId]) Parameters: - pCodField (CHARACTER): Código do atributo - pGroupId (CHARACTER): Agrupador onde o atributo está contido Retorno (JsonObject): Um atributo	- Purpose: Retorna um JsonObject que representa um Atributo
addField(pCodField, pCodLabel, pCodType [, pPosition] [, pGroupId]) Parameters: - 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 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 - pGroupId (CHARACTER): Agrupador onde o atributo está contido Retorno (JsonObject): Atributo Incluído	- Purpose: Incluir um novo Atributo
changeFieldOrder(pCodField [, pPosition] [, pGroupId]) Parameters: - pCodField (CHARACTER): Código do Atributo - 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 - pGroupId (CHARACTER): Agrupador onde o atributo está contido Retorno (LOGICAL): Indicativo se foi possível alterar a ordem	- Purpose: Altera a Ordem de um Atributo
setFieldValidate(pCodField, pCodProg [, pGroupId]) setFieldValidateCustom(pCodField, pEndpoint [, pGroupId]) Parameters: - pCodField (CHARACTER): Código do atributo - pCodProg (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 Retorno (LOGICAL): Indicativo se foi possível incluir a propriedade no atributo	- Purpose: Incluir a propriedade 'validate' no atributo (monitora a alterado do campo - evento validateField)
addValidateFields(pCodField) Parameters: - pCodField (CHARACTER): Código do atributo Retorno (LOGICAL): Lógico indicativo se foi possível incluir o atributo Nota: Utilizar este método para tela que implementam o componente DynamicForm	- Purpose: Inclui um atributo no ValidateFields do Formulário (evento validateForm)
isChangedField(pCodField) Parameters: - pCodField (CHARACTER): Código do atributo Retorno (LOGICAL): Lógico indicativo se o atributo teve seu valor alterado	- Purpose: Verifica se um Atributo foi alterado (eventos ValidateForm e ValidateField)
getReturnRoot() Retorno (JsonObject): Root de retorno	- Purpose: Retorno 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) Parameters: - pCodField (CHARACTER): Código do atributo Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL,DATE,JsonObject,JsonArray): Valor do atributo	- Purpose: Retorna o valor de um atributo
setFieldValue(pCodField, pCodValue) Parameters: - pCodField (CHARACTER): Código do atributo - pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL,DATE): Novo valor Retorno (LOGICAL): Indicativo se foi possível alterar o atributo	- Purpose: Altera o valor de um Atributo
getFieldValues() Retorno (JsonObject): Valores do registro	- Purpose: Retorno um JsonOject que representa os Valores do registro ou retorno(eventos ValidateForm e ValidateField)

...

---------------------
CLASSE: CustomActions - Purpose: Customizações de Ações da Página e da Tabela
---------------------

Método	Descrição	Exemplo
setAction(pCodAction, pCodValue) Parameters: - pCodAction (CHARACTER): Código da Action - pCodValue: Valor da Action, usar uma das opções: - pCodURL (CHARACTER): Valor da URL a ser executada pela Action - pCodValue (LOGICAL): Valor da Action Retorno (LOGICAL): Indicativo se foi possível incluir/alterar a Action	- Purpose: Inclui ou Altera uma Action Padrão
getActionCharacter(pCodAction) getActionLogical(pCodAction) Parameters: - pCodAction (CHARACTER): Código da Action Retorno (CHARACTER,LOGICAL): Valor da Action	- Purpose: Retorna o valor de uma Action Padrão
removeAction(pCodAction) Parameters: - pCodAction (CHARACTER): Código da Action Retorno (LOGICAL): Indicativo se foi possível remover a Action	- Purpose: Remove uma Action Padrão
getActions() Retorno (JsonObject): Actions padrões	- Purpose: retorna um JsonObject que representa as Actions Padrão
setPageCustomActionProperty(pIdAction, pCodProperty, pCodValue) Parameters: - pIdAction: Identificador da Action, usar uma das opções: - pCodLabel (CHARACTER): Label da Action - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions - pCodProperty (CHARACTER): Propriedade que deve ser alterada - pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor Retorno (LOGICAL): Indicativo se foi possível alterar a propriedade	- Purpose: Altera uma propriedade de uma Action Customizada de Página
getPageCustomActionPropertyCharacter(pIdAction, pCodProperty) getPageCustomActionPropertyInteger(pIdAction, pCodProperty) getPageCustomActionPropertyDecimal(pIdAction, pCodProperty) getPageCustomActionPropertyLogical(pIdAction, pCodProperty) Parameters: - pIdAction: Identificador da Action, usar uma das opções: - pCodLabel (CHARACTER): Label da Action - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions - pCodProperty (CHARACTER): Propriedade Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade	- Purpose: Retorna o valor de uma propriedade de uma Action Customizada de Página
getPageCustomAction(pIdAction) Parameters: - pIdAction: Identificador da Action, usar uma das opções: - pCodLabel (CHARACTER): Label da Action - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions Retorno (JsonObject): Uma Action Customizada de Página	- Purpose: Retorna um JsonObject que representa uma Action Customizada de Página
addPageCustomAction(pNumType, pCodLabel, pCodAddress [, pCodIcon]) Parameters: - pNumType: Tipo da Action, 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 Action - pCodAddress (CHARACTER): Endereço da Action que será executada - pCodIcon (CHARACTER): Ícone da Action Retorno (JsonObject): Action Customizada de Página Incluída	- Purpose: Incluir uma nova Action Customizada na Página
removePageCustomAction(pIdAction) Parameters: - pIdAction: Identificador da Action, usar uma das opções: - pCodLabel (CHARACTER): Label da Action - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions Retorno (LOGICAL): Indicativo se foi posssível remover a Action	- Purpose: Remove uma Action Customizada de Página
getPageCustomActions() Retorno (JsonArray): Actions Customizadas de Página	- Purpose: Retorna a lista de Actions Customizadas de Página
setTableCustomActionProperty(pIdAction, pCodProperty , pCodValue) Parameters: - pIdAction: Identificador da Action, usar uma das opções: - pCodLabel (CHARACTER): Label da Action - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions - pCodProperty (CHARACTER): Propriedade que deve ser alterada - pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor Retorno (LOGICAL): Indicativo se foi possível alterar a propriedade	- Purpose: Altera uma propriedade de uma Action Customizada de Tabela
getTableCustomActionPropertyCharacter(pIdAction, pCodProperty) getTableCustomActionPropertyInteger(pIdAction, pCodProperty) getTableCustomActionPropertyDecimal(pIdAction, pCodProperty) getTableCustomActionPropertyLogical(pIdAction, pCodProperty) Parameters: - pIdAction: Identificador da Action, usar uma das opções: - pCodLabel (CHARACTER): Label da Action - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions - pCodProperty: Propriedade Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade	- Purpose: Retorna o valor de uma propriedade de uma Action Customizada de Tabela
getTableCustomAction(pIdAction) Parameters: - pIdAction: Identificador da Action, usar uma das opções: - pCodLabel (CHARACTER): Label da Action - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions Retorno (JsonObject): Uma Action Customizada de Tabela	- Purpose: Retorna um JsonObject que representa uma Action Customizada de Tabela
addTableCustomAction(pNumType, pCodLabel, pCodAddress [, pCodIcon] [, pConcatKeys]) Parameters: - pNumType: Tipo da Action, 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 Action - pCodAddress (CHARACTER): Endereço da Action que será executada - pCodIcon (CHARACTER): Ícone da Action - pConcatKeys (LOGICAL): Indica se deve ser acrescentada a propriedade "concatKeys" na Action Retorno (JsonObject): Action Customizada de Tabela Incluída	- Purpose: Incluir uma nova Action Customizada na Tabela
removeTableCustomAction(pIdAction) Parameters: - pIdAction: Identificador da Action, usar uma das opções: - pCodLabel (CHARACTER): Label da Action - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions Retorno (LOGICAL): Indicativo se foi posssível remover a Action	- Purpose: Remove uma Action Customizada de Tabela
getTableCustomActions() Retorno (JsonArray): Actions Customizadas de Tabela	- Purpose: Retorna a lista de Actions Customizadas de Tabela
getServerAddress(pIsExt) Parameters: - 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	- Purpose: Retorna o Endereço onde o Datasul está hospedado

...

--------------------
CLASSE: CustomRecord - Purpose: Customizações de Registros
--------------------

Método	Descrição	Exemplo
getEntityKeyCharacter() getEntityKeyInteger() Retorno (CHARACTER,INTEGER): Chave do registro	- Purpose: Retorna a chave do Registro na manipulação do Metadata (alteração, detalhe)
updateRecords(pProg, pPiName) Parameters: - pProg (HANDLE): Handle do programa UPC - pPiName (CHARACTER): Nome da PI que será executada a cada registro dos dados Retorno (LOGICAL): Indicativo se é possível alterar o registro Nota: A PI deve receber como parâmetro um JsonObject que representa o registro, ex: DEF INPUT PARAM oItem AS JsonObject NO-UNDO.	- Purpose: Navega nos registros e executa uma PI interna da UPC para customização dos dados

...

----------------------
CLASSE: CustomMessages - Purpose: Geração de Mensagens
----------------------

Método	Descrição	Exemplo
createMessageError(pMsgNumber, pMsgDescription, pMsgHelp) Parameters: - pMsgNumber (INTEGER): Número da Mensagem - pMsgDescription (CHARACTER): Descrição da Mensagem - pMsgHelp (CHARACTER): Help da Mensagem Retorno (JsonObject): Mensagem no padrão TOTVS de Mensagem	- Purpose: Cria uma mensagem do tipo ERROR para enviar ao FrontEnd

...

Árvore de páginas

Versões comparadas

Versão antiga 12

Nova versão 13

Chave