Exibir origem

CONTEÚDO

01. Visão Geral

No módulo de Jurídico Departamentos (SIGAJURI), foi criado uma interface personalizável para as telas de consultas padrão, a fim de permitir pesquisa sem diferenciação por acentuação ou caixa alta/baixa. Estas consultas utilizam uma chamada da função JURSXB(). Este documento tem o objetivo de apresentar que é possível personalizar o comportamento das consultas que usam esta função, caso necessário. Veja a seguir os parâmetros da função.

02. Parâmetros da função JURSXB()

Para utilizar esta função, é necessário configurar alguns parâmetros, como vemos na tabela a seguir:

JURSXB( A, B, C, D, E, F, G , H , I , J )

Parâmetro	Tipo	Descrição	Obrigatório	Exemplo
A	String	Nome da tabela.	x	"SA2"
B	String	Nome da consulta específica	x	"JURSA2"
C	Array	Campos que devem ser exibidos na tela da consulta.		{"A2_COD","A2_LOJA","A2_NOME"}
D	Lógico	Define se o botão Visualizar será apresentado.		.T.
E	Lógico	Define se o botão Incluir será apresentado.		.T.
F	String	Filtro (where) que será concatenado na query		""
G	String	Nome da rotina/fonte que será usado para visualização ou inclusão de registros a partir da consulta padrão.		"MATA020"
H	Lógico	Indica se a consulta apresentará dados na sua abertura. Caso configure .F. os valores serão retornados somente ao realizar uma busca no campo de pesquisa.		.T.
I	Numérico	Percentual de redução da view quando é informado o fonte.		0
J	Lógico	Define se o botão Alterar será apresentado.		.T.

03. Como configurar?

Para realizar as configurações é necessário acessar o configurador (SIGACFG), conforme apresentado a seguir:

1 - Acesse o módulo do Configurador

No menu acesse Base de Dados > Dicionário > Base de Dados. Em seguida, no menu lateral, selecione o item Consultas Padrão:

2 - Utilize o botão de lupa para buscar a consulta que deseja configurar.

Linha Microsiga Protheus > JURSXB() - Configurações para consulta específica > image2020-7-15_14-16-2.png

Digite o nome do Alias da consulta padrão e clique no botão Buscar:

Linha Microsiga Protheus > JURSXB() - Configurações para consulta específica > image2020-7-15_14-17-9.png

3 - Acesse a consulta em modo de Alteração.

Clique no botão Alterar:

Linha Microsiga Protheus > JURSXB() - Configurações para consulta específica > image2020-7-15_14-18-21.png

Ao acessar a tela da consulta no modo de alteração, clique em Avançar

Linha Microsiga Protheus > JURSXB() - Configurações para consulta específica > image2020-7-15_14-21-17.png

4 - Configure os parâmetros para a função JURSXB()

No campo Expressão configure os parâmetros de acordo com a necessidade para o campo que utiliza a consulta.

Linha Microsiga Protheus > JURSXB() - Configurações para consulta específica > image2020-7-15_14-22-40.png

Após realizar as alterações necessárias, clique no botão Finalizar.

04. Exemplo de utilização

A seguir vemos o exemplo de configuração para consulta específica do campo de Comarca (NUQ_CCOMAR), utilizado na rotina de Assuntos Jurídicos.

Expressão: JURSXB( "NQ6", "NQ6" ,{ "NQ6_COD", "NQ6_DESC" } , .T., .T., "@#JU183F3NQ6()", "JURA005", .T., 0, .T.)

Linha Microsiga Protheus > JURSXB() - Configurações para consulta específica > image2020-7-15_14-37-2.png

Utilizando a Consulta:

Linha Microsiga Protheus > JURSXB() - Configurações para consulta específica > image2020-7-15_14-44-17.png

05. Utilização de filtros - Totvs Departamentos Jurídicos

A seguir veremos como será a utilização dos filtros nas consultas a partir da JURSXB. A regra a seguir vale para a utilização no portal Totvs Departamentos Jurídico. Para os filtros podemos utilizar as seguintes formas:

Filtro por posição do registro na memória
- Expressão: JURSXB("NT9","JURCST",{"NT9_NOME","NT9_CODENT"},.T.,.T.,"NT9->NT9_CAJURI==NSZ->NSZ_COD")
- Explicação: O Filtro por posição será convertido para uma condição que irá comparar ao menos dois campos na consulta, realizando o filtro desejado. Importante ressaltar que apenas filtros complementares com a NSZ estão disponíveis.

Filtro por função
- Expressão: JURSXB("CT1","JURFNC",{"CT1_CONTA","CT1_DESC01"},.T.,.T.,"@#U_CT1JUR_NW()")
- Explicação: O filtro por função executará a função inserida, tal função deverá retornar uma condição que por sua vez será utilizada para complementar a busca pelo registro. Importante ressaltar que é necessário a indicação do @# antes da função.
  Exemplo de retorno de uma função: " CT1_CLASSE == '2' And CT1_BLOQ <> '1' ".

Filtro por campo do formulário
- Expressão: JURSXB("SB1","SB1T10",{"B1_DESC","B1_COD"},.T.,.T.,"@#U_JQRYF301(oJson)")
- Explicação: O filtro por campo do formulário executará a função inserida, passando os valores do formulário no Totvs Departamentos Jurídico via parâmetro, tal função deverá retornar uma condição que por sua vez será utilizada para complementar a busca pelo registro. Importante ressaltar que é necessário a indicação do @# antes da função e seu parâmetro oJson.
  Exemplo de retorno de uma função: " B1_DESC like '%PRODUTO%' ".
- Para mais informações, olhar a seção abaixo.

06. Utilização de filtros pelos campos do formulário - Totvs Departamentos Jurídicos

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.

Função com filtro de campos

Nessa etapa estaremos tratando do filtro que será executado ao consultar o campo customizado.
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.
A partir disso o usuário pode criar a condição SQL desejada, utilizando ou não os campos do formulário.
Importante: O retorno dessa função deve ser uma condição SQL, sem a necessidade do AND no início

Exemplo de função e retorno, considerando o filtro de campos:

//-------------------------------------------------------------------
/*/{Protheus.doc} JQRYF301
Função montagem da query que será usada para filtrar os registros da consulta padrão

@param oJson -  Objeto JSON contendo os campos do formulário para Totvs Departamento Jurídico.
				Esse Objeto vem por padrão NIL no caso de execução via Protheus.

@return cQuery - Condição da Query sem AND no início
/*/
//--------------------------------------------------------------------  
USER FUNCTION JQRYF301(oJson)
Local cQuery    := ""
Local oModel    := FWModelActive()

Default oJson   := Nil

    If oJson == Nil .Or. Empty(oJson:toJson())
        If isBlind()
            // Caso seja Totvs Departamento Jurídico e Visualização do GRID, usar o posicione da tabela (NUQ)
            cQuery := retWhere(AllTrim(NUQ->NUQ_XCARAC), AllTrim(NUQ->NUQ_XNATUR))
        Else
            // Caso seja Protheus, usar o modelo para pegar o valor do campo atualizado
            cQuery := retWhere(AllTrim(oModel:GetValue("NUQDETAIL", "NUQ_XCARAC")))
        EndIf
    Else
        // Caso seja Totvs Departamento 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" .Or. cNatut == "0002"
        cReturn := "O0N_CSLDOC like '%" + cNUQXCarac + "%' and O0N_TIPO = '1'"
    ElseIf cNatut == "0003" .Or. cNatut == "0004"
        cReturn := "O0N_CSLDOC like '%" + cNUQXCarac + "%' and O0N_TIPO = '2'"
    Else 
        cReturn := "O0N_CSLDOC like '%" + cNUQXCarac + "%'"
    EndIf

Return cReturn

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" é utilizada como boas práticas para evitar a repetição da regra de negócio que envolva a montagem da query, centralizando esse comportamento.
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.
2. Se o oJson estiver vazio e isBlind() = verdadeiro: Indica ambiente Totvs Departamento Jurídico e Visualização pelo GRID, utilizando posicionamento via tabela desejada (No exemplo acima é NUQ) para obter os valores dos campos.
3. Se o oJson estiver vazio e isBlind() = falso: Indica ambiente Protheus, utilizando o modelo ativo (FWModelActive) para obter os campos atualizados.
4. Se o oJson estiver preenchido: Indica ambiente Totvs Departamento Jurídico, utilizando os campos do formulário através do parâmetro oJson.
5. 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

3.1 Exemplo de uso:

a. Ao acessar a tela de instâncias, sem nenhum dado preenchido, o campo de consulta retorna com todos os valores disponíveis:

Linha Microsiga Protheus > JURSXB() - Configurações para consulta específica > image-2025-9-12_17-20-7.png

b. Ao digitar no campo de caractere (NUQ_XCARAC), inserindo a palavra "Banco" e consultando novamente, são retornados os dados que contenham "BANCO" em sua descrição:

Linha Microsiga Protheus > JURSXB() - Configurações para consulta específica > image-2025-9-12_17-23-49.png

c. Ao "alterar instância", é possível visualizar os campos customizados no grid de instâncias, nos detalhes do processo:

Linha Microsiga Protheus > JURSXB() - Configurações para consulta específica > image-2025-9-12_17-25-24.png

07. Assuntos relacionados

Consultas Específicas

<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>