Árvore de páginas

Versões comparadas

Chave

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

...

  1. Consulta da JURSXB - Consulta padrão
    1. Nessa etapa estaremos criando a consulta que o campo customizado executará.
    2. Esse filtro está disponível apenas para funções compiladas, incluindo customizações.
    3. Para isso é necessário passar como parâmetro da função o oJson, esse será o parâmetro que armazenará os dados do formulário no Totvs Jurídico Departamentos. Importante: Sem a passagem do parâmetro, a função não terá acesso aos dados do formulário.
    4. Exemplo de consulta JURSXB considerando o filtro de campos:
    5. Observações: 
      1. Esse filtro está disponível apenas para campos customizados.
      2. Após criar / editar a consulta padrão, é necessário vincular ao campo que executará a consulta.
  2. Função com filtro de campos
    1. Nessa etapa estaremos tratando do filtro que será executado ao consultar o campo customizado.
    2. Seguindo a mesma regra da etapa anterior, precisamos criar a função com um parâmetro oJson, o mesmo que receberá os campos e seus valores.
    3. A partir disso o usuário pode criar a condição SQL desejada, utilizando ou não os campos do formulário.
    4. Importante: O retorno dessa função deve ser uma condição SQL, sem a necessidade do AND no início
    5. Exemplo de função e retorno, considerando o filtro de campos:

      Bloco de código
      languagejava
      themeRDark
      USER FUNCTION JQRYF301(oJson)
      Local cQuery    := ""
      Local oModel    := FWModelActive()
      Default oJson   := Nil
      
          If oJson == Nil .Or. Empty(oJson:toJson())
              If isBlind()
                  // Caso seja TJD + GridTotvs Departamento Jurídico e Visualização do GRID, usar o posicione da viatabela (NUQ)
                  cQuery := retWhere(AllTrim(NUQ->NUQ_XCARAC), AllTrim(NUQ->NUQ_XNATUR))
              Else
                  // Caso seja protheusProtheus, useusar o modelo para pegar o valor do campo atualizado
                  cQuery := retWhere(AllTrim(oModel:GetValue("NUQDETAIL", "NUQ_XCARAC")))
              EndIf
          Else
              // Caso seja Totvs TJDDepartamento Jurídico, usar campos do formulário pelo oJson
              If !Empty(oJson["NUQ_XCARAC"])
                  cQuery := retWhere(UPPER(oJson["NUQ_XCARAC"]), AllTrim(oJson["NUQ_XNATUR"]))
              EndIf
          EndIf
      
      Return cQuery  
      
      //-------------------------------------------------------------------
      /*/{Protheus.doc} retWhere
      Função para centralizar a regra de negócio na montagem da Query
      
      @param cNUQXCarac - Campo customizado de descrição
      @param cNatut     - Campo customizado de natureza
      
      @return cReturn - Condição da Query sem AND no início
      /*/
      //-------------------------------------------------------------------- 
      Static Function retWhere(cNUQXCarac, cNatut)
      Local cReturn := ""
      
      Default cNUQXCarac := ""
      Default cNatut     := ""
      
          If cNatut == "0001" .orOr. cNatut == "0002"
              cReturn := "O0N_CSLDOC like '%" + cNUQXCarac + "%' and O0N_TIPO = '1'"
          ElseIf cNatut == "0003" .orOr. cNatut == "0004"
              cReturn := "O0N_CSLDOC like '%" + cNUQXCarac + "%' and O0N_TIPO = '2'"
          Else 
              cReturn := "O0N_CSLDOC like '%" + cNUQXCarac + "%'"
          EndIf
      
      Return cReturn
    6. Observações:

      1. A função deve ser a mesma que foi inserida na consulta, na etapa anterior.
      2. A função deve retornar uma condição SQL sem o AND no início.
      3. Essa função deve estar compilada no ambiente.
      4. Para filtrar pelos valores do formulário, utilizamos o parâmetro oJson[<nome_do_campo>], como no exemplo onde está sendo filtrado pelo campo customizado NT3_XCARAC.
      5. Importante: Apenas campos caractere estão disponíveis para serem usados como filtro. Campos com X3_TIPO = 'C'.
      6. A função "retWhere" filtra por diferentes tipos conforme a natureza informada.é utilizada como boas práticas para evitar a repetição da regra de negócio que envolva a montagem da query, centralizando esse comportamento.
    7. Observações sobre os cenários possíveis de uso:
      1. A função isBlind() verifica a existência de uma interface Protheus na execução, caso exista a interface o valor retornado será .F., caso contrário será .T. como em cenários do Totvs Departamento Jurídico.
      Observações:
      1. Se o oJson estiver vazio e isBlind() = verdadeiro: Indica ambiente Web App e GridTotvs Departamento Jurídico e Visualização pelo GRID, utilizando posicionamento via tabela desejada (No exemplo acima é NUQ) para obter os valores dos campos.
      2. Se o oJson estiver vazio e isBlind() = falso: Indica ambiente Protheus, utilizando o modelo ativo (FWModelActive) para obter os campos atualizados.
      3. Se o oJson estiver preenchido: Indica ambiente Web AppTotvs Departamento Jurídico, utilizando os campos do formulário através do parâmetro oJson.
      4. Para todos os cenários indicamos o uso da função Empty() para validar o valor antes de inserir na query, evitando comportamentos indesejados.

3. Exemplo de uso:

    1. Ao acessar a tela de despesa, nenhum dado foi preenchido, assim o campo de consulta retorna todos os valores. Importante: Por padrão é filtrado os registros não deletados e que estejam na filial correspondente ao do usuário.
    2. Ao digitar no campo de caractere (NT3_XCARAC), onde foi digitado a palavra "requeijao" e ao consultar novamente é retornado os produtos que contenham "REQUEIJAO" em sua descrição

...