01. DADOS GERAIS
Linha de Produto: | Microsiga Protheus® |
---|---|
Segmento: | Backoffice |
Módulo: | Financeiro |
Idiomas: | Português |
Função: | Portal do Cliente |
02. DESCRIÇÃO
Atenção
O ponto de entrada foi liberado através do pacote de expedição continua do módulo financeiro após Outubro.
O ponto de entrada PCBROWSE permite incluir opções de menu para listagem de itens customizados ao Portal do Cliente - SIGAFIN.
O ponto de entrada deve retornar um array com o json de configuração de cada menu que deseja adicionar.
03. CONFIGURAÇÃO
Parâmetros disponibilizados no ponto de entrada:
PARAMIXB | Tipo | Descrição |
---|---|---|
1º Posição | Character | Usuário de login do Portal do cliente. |
Configuração necessário para que seja carregada a opção de menu no portal do cliente. Caso alguma informação obrigatória, função de usuário informada não compilada ou erro de execução ocorra o menu não será carregado.
Propriedade | Obrigatoriedade | Descrição |
---|---|---|
tituloMenu | Obrigatório | Título apresentado no menu. |
iconeMenu | Opcional | Ícone para o menu. Lista de ícones PO UI que podem ser usados nesta propriedade. https://po-ui.io/guides/icons |
tituloPagina | Obrigatório | Título apresentado na página. |
funcaoQuery | Obrigatório | Nome da User Function que vai retornar a query para buscar os dados. |
orderQuery | Opcional | Campo no qual a ordenação da tabela vai se basear. |
tabela | Obrigatório | Alias da tabela utilizada para tratamento interno. |
colunas | Obrigatório se não enviar fields | Array de campos do browse, o sistema vai utilizar o titulo da SX3. Se informar fields essa propriedade é ignorada. |
fields | Opcional | Array de json com os campos do browse. Cada campo deve ter as propriedades property, type e label (PoTableColumn):
|
legendas | Opcional | Configuração das legendas. Array de json com as propriedades value, color e label. (labels do PoTableColumnLabel) |
campoLegendas | Opcional | Campo utilizado para legenda. |
tituloLegendas | Opcional | Título da legenda. |
detalhes | Opcional | Json com as propriedades para ser exibido na tela de detalhes do registro. Consulte o item 03.02 Configuração de detalhes. |
03.01. CONFIGURAÇÃO DE PESQUISA
É possível configurar a pesquisa simples e avançada através da configuração:
Propriedade | Obrigatoriedade | Descrição |
---|---|---|
campoBusca | Opcional | Campo para busca rápida. |
camposBuscaAvancada | Opcional | Lista de campos para busca avançada, o sistema vai utilizar o titulo da SX3. Se informar fieldsBuscaAvancada essa propriedade é ignorada. |
fieldsBuscaAvancada | Opcional | Array de json com os campos para utilizar na busca avançada. Cada campo deve ter as propriedades property, type e label (PoDynamicFormField):
|
03.02. CONFIGURAÇÃO DE DETALHES
Caso seja configurado os detalhes, será apresentado no item a opção "visualizar" para exibição de informações e listagem de itens.
Propriedade | Obrigatoriedade | Descrição |
---|---|---|
tituloPagina | Obrigatório | Título apresentado na página de detalhes. |
tituloAbaPrincipal | Obrigatório | Título apresentado na aba principal. |
camposDetalhes | Obrigatório | Lista de campos que serão apresentados, o sistema vai utilizar o titulo da SX3. Se informar fieldsDetalhes essa propriedade é ignorada. |
fieldsDetalhes | Opcional | Array de json com os campos do browse. Cada campo deve ter as propriedades property, type e label (PoTableColumn):
|
orderQueryItens | Opcional | Campo no qual a ordenação da tabela vai se basear. |
tituloAbaItens | Opcional | Título apresentado na aba itens. |
funcaoQueryItens | Obrigatório se informado tituloAbaItens | User Funcion que vai retornar a query dos itens. |
tabelaItens | Obrigatório se informado tituloAbaItens | Alias dos itens. |
colunas | Obrigatório se informado tituloAbaItens | Lista de campos do browse, o sistema vai utilizar o título da SX3. Se informar fields essa propriedade é ignorada. |
fields | Obrigatório se informado tituloAbaItens | Array de json com os campos do browse. Cada campo deve ter as propriedades property, type e label (PoTableColumn):
|
04. USER FUNCTION QUERY
A função passada na propriedade 'funcaoQuery' e 'funcaoQueryItens' será chamada pelo Portal do Cliente para que retorne a query customizada que será utilizada na busca dos itens.
funcaoQuery recebe os parâmetros:
PARAMIXB | Tipo | Descrição |
---|---|---|
1º Posição | Array | Contém um Array com as chaves (FILIAL+CODIGO+LOJA) dos clientes selecionados no portal. Cada posição do Array contém um objeto Json com as propriedades: filial, codigo e loja. |
2º Posição | Caracter | Usuário de login do Portal do cliente |
funcaoQueryItens recebe os parâmetros:
PARAMIXB | Tipo | Descrição |
---|---|---|
1º Posição | Array | Contém um Array com as chaves (FILIAL, CODIGO, LOJA) dos clientes selecionados no portal. Cada posição do Array contém um objeto Json com as propriedades: filial, codigo e loja. |
2º Posição | Caracter | Usuário de login do Portal do cliente |
2º Posição | Json | Json da linha selecionada no formato "{ Campo: Valor } " Ex.: "{ E1_FILIAL: '01', E1_NUM: '000001' }" |
Retorno do ponto de entrada:
A função deve retornar a query personalizada:
Deverão ser utilizados os Id's:
#QueryFields# Campos do SELECT, existe tratamento para o FIELDS no QueryParam
#QueryWhere# Condições do WHERE, existe tratamento para FILTER no QueryParam
Tipo | Obrigatoriedade | Descrição |
---|---|---|
Caractere | Obrigatório | Query personalizada para listagem dos registros do menu customizado. |