Para uso com o smartview devem ser implementados os métodos:

GET objectschema

Retorna o schema, que é um descrição de campos e tipos de dados.

POST data

Dados do relatório.

Foi criado um conjunto de ferramentas que facilitam a geração do endpoint na include utp/ut-sv-utils.i.

Utilize as mesmas ferramentas que usa para construir um endpoint comum, acrescentando anossa include de ferramentas.

Abaixo destaco, na arquitetura normal de um endpoint o que deve ser feito a mais na construção do endpoint para que ele seja utilizado no Smart View.

Image Added

Constantes:

Algumas constantes mudam o comportamento da geração dos dados, são elas

SV-PAGE-SIZE

Número de linhas da página de dados, seu valor dafault é 5000, essa constante é muito importante para ajustar a performance do relatório, reduza esse número caso cada registro de dado tenha muita informação ou aumente caso tenha pouca informação.

SV-PRNAME

Nome do prefixo do campo calculado, seu valor default é calc

Cada campo calculado deve ter  um procedure para seu calculo essa procedure deve ter o nome dessa constane mais o nome do campo calculado.

SV-MODO

O modo como são gerados os nomes para envio ao Smart View, seu default é TBATR, que significa que se enviar a tabela impressora e o campo des_impressora será enviada uma composição entre o nome da tabela e do atributo.

Os valores possíveis são:

DBTBATR → banco tabela atributo

TBATR → tabela atributo

ATR → atributo

SV-SEP

Caractere separador na concatenação dos campos o default é _ (Underline) e pode ser usado ? para não usar nenhum separador.

Procedure generateSchema

Nessa procedure deve detalhar o schema de seu endpoint.

A declaração dessa procedure é obrigatória e caso ele não exista o retorno será uma mensagem de erro de código 52611.

Nela se inclui:

• • • • Atributos do schema seja eles relacionados a tabelas físicas ou temporárias
      • Campos calculados
      • Parâmetros do relatório

Foram criadas diversas formas de inclusão de atributos visando facilitar seu uso, abaixo imagem de um exemplo de implementação:

Image Added

clearSchema

Limpa a definição de Schema

addSchemaItemHandle

Adiciona um item ao schema, recebe como parâmetro:

Handle buffer-field do atributo - handle

Se o atributo permite filtro - logical

Se o atributo é obrigatório - logical

A url de filtro (opcional) - character

addSchemaItemHandleAtrNAme

Adiciona um item ao schema já atribuindo um nome para envio ao Smart View, recebe como parâmetro:

svAtrName - nome do atributo

Handle buffer-field do atributo - handle

Se o atributo permite filtro - logical

Se o atributo é obrigatório - logical

A url de filtro (opcional) - character

addSchemaTable

Adiciona todos os atributos de uma tabela, recebe como parâmetro:

Handle buffer da tabela - handle

addSchemaTableWithExceptions

Adiciona todos os atributos de uma tabela, com exceção dos enviados como parâmetro, recebe como parâmetro:

Handle buffer da tabela - handle

Lista de exceção separada por vírgula - character

delSchemaItem

Elimina um item do schema, recebe como parâmetro:

Atributo smartView - character

addSchemaItem

Adiciona manualmente um item ao Schema.

schemaItem - objeto

O objeto deve ser construido com o parâmetro add Ex.: mySchema = NEW schemaItem("add").

updSchemaItem

Altera um item ao Schema.

schemaItem - objeto

O objeto deve ser construido com o parâmetro add Ex.: mySchema = NEW schemaItem("upd").

Atribua somente as propriedades que deseja alterar e svAtrName é obrigatório pois é chave.

addSchemaParameter

Adiciona um parâmetro ao relatório, os parÂmetros são solitados quando o relatório e executado a partir do Smart View.

schemaParameter - objeto

Objeto schemaItem

As procedures de inclusão e alteração de itens recebem um objeto do tipo schemaItem que usam como referÊncia para essa operação, abaixo a lista de seus atributos

svAtrName - nome do atributo afetado é usando como chave para a operação

svDatabase - nome do banco

svTable - nome da tabela

svExt - numero do extent, use um número maior que 0 (zero) para campos extent

svField - nome do atributo ou da procedure, caso seja um campo calculado

svDisplayName - nome de display

svDescription - descrição

svAtrType - tipo de dado, usar os tipos de progress (character, logical, date ...)

svFiltered - Se o atributo permite filtro

svRequired Se o atributo é obrigatório

svType - o tipo do atributo  1-tabela 2-temp-table 3 - campo calculado

svOptionsUrl - A url de filtro (opcional) - character - Pode ser incluído um endpoint no qual é utilizado para a obtenção de valores do OptionsUrl e/ou Dropdown (Mais detalhes na sessão endpoint optionsdatakeylabel)

Objeto schemaParameter

svName - código do parâmetro

svDisplayName - nome de display

svType - tipo de dado, usar os tipos de progress (character, logical, date ...)

svMultiValue - Se o valor é multivalorado ou não

svLookupUrl - URL de lookup para permitir buscas no parâmetro (Ex.: "/btb/api/v1/meuObjetodeNegocio/lookup")

Procedure pLookup

Para habilitar o uso do lookup, realize o vinculo de uma tabela (temporária ou não) a procedure pLookup, conforme exemplo abaixo, onde o índice da tabela determina o campo em que será realizado a busca.

Image Added

Após realizar o vinculo da tabela é necessário executar a função LookupParameter, na seguinte estrutura (BUFFER DA TABELA, cFilter, OUTPUT oJsonOutput), para que seja retornado o JSON no formato aceito pelo Smart View.

Procedure GetPagenr

Nessa procedure é realizado o retorno dos números responsáveis pela paginação.

Campo calculado

É possível criar um campo calculado como no exemplo abaixo:

Image Added

Como nome do banco e tabela deve informar o banco que deseja receber o buffer para os cálculos e o nome do atributo é o nome da procedure do cálculo com o prefixo da constante SV-PRNAME.

Essa procedure recebe o handle do buffer da tabela indicada e devolve o valor do cálculo no tipo do item adicionado.

O endpoint objectschema

O endpoint retorna o schema baseado nas definições da procedure generateSchema.

Image Added

A procedure generateProperties é a responsável por criar o schema baseado na procedure generateSchema:

generateProperties

Gera json com o SChema, recebe como parâmetro:

DisplayName - character

Name - character

Description - character

DataUrl -  character

Retorna:

Json Schema - jsonObject

O parâmetro DataUrl é importante e deve ter o endereço no endpoint e é usada para montar algumas URLs durante o retorno de dados.

O catch no código serve para capturar um eventual erro 

O createJsonResponse cria o json de resposta no padrão

Endpoint data

Retorna os dados do relatório, respeitando o filtro e parâmetros recebidos do SmartView.

Foram criados facilitadores para tratar os parâmetros (processParameters e processParameterMultiple)  e filtros (generateFilter) que irão compor a clausula where que fará o retorno dos dados.

O procedure generateData é responsável pela montagem do Json de saída, fazendo o controle de paginação.

Image Added

Abaixo a lista de facilitadores e seus parâmetros:

processParameters

Tem por função retornar os parâmetros recebidos no json de entrada em uma string que representa uma porção da clausula where.

oJsonInput - jsonObject

string entrada - character

retorna:

string saida - character

Na string de entrada informe o nome do parâmetro precedido por &, no retorno esse valor será substituido pelo parâmetro recebido.

processParametersMultiple

Tem por função retornar um parâmetro multiplo recebido no json de entrada em uma string que representa uma porção da clausula where.

oJsonInput - jsonObject

parâmetro pesquisado - string

string de ligação - string

string entrada - character

retorna:

string saida - character

Diferente da processParameters a processParametersMultiple duplica a string de entrada a cada ocorrência de um parâmetro.

Informe o nome do parâmetro multiplo que deseja no parâmetro pesquisado e na string de entrada o mesmo parâmetro precedido por &, no retorno esse valor será substituido pelo parâmetro recebido, a string de ligação é a string que será usada entre um valor múltiplo e outro, usualmente um AND ou OR, mas pode se usar um caractere delimitador para usar em um options, por exemplo.

generateFilter

Transforma o json de filtro em uma string de filtro com sintaxe do Progress, recebe o parâmetro:

oJsonInput - jsonObject

Retorna:

filtro - character

generateData

handle de tabela ou handle de query - handle

cURI - character

cFilter - character

Retorna:

Json Data - jsonObject

O primeiro parâmetro pode ser o handle de uma query ou o handle de uma tabela

cURI - é a URL da requisição, usada na paginação

cFilter - só é valido quando recebe o handle de uma tabela, e ignorado quando é o handle de uma query.

Para o uso de temp-table como repositório de dados, é necessário realizar a definição da temp-table e após utilizar o facilitador abaixo:

generateDataTT

handle de tabela ou handle de query - handle

cURI - character

cFilter - character

QUERY-OFF-END - handle

Retorna:

Json Data - jsonObject

Confira o exemplo abaixo:

Image Added

O endpoint optionsdatakeylabel 

Retorna um JsonObject no padrão key-value para a utilização na obtenção de dados para os componentes Options e Dropdown (no SmartView).

Por padrão, o nome do endpoint deve ser optionsdatakeylabel, porém caso desejar, pode ser implementado um endpoint com outro nome para o retorno exclusivo de dados (Ambos configurados em generateSchema).

Image Added

clearOptions

Limpa a definição dos objetos de Options

addOptionsItem

Adiciona um item ao objeto de Options, recebe como parâmetros:

Chave - character

Valor - character

generateOptionsData

Transforma os dados enviados em um JsonObject no formato key-value (utilizados no SmartView).

{
    "dataUrl": "http://localhost:8080/api/btb/v1/svUsuarDetail/data",
    "displayName": "Detalhes do usuário",
    "name": "UsuarDetail",
    "description": "Listagem dos detalhes",
    "areas": [
        "Datasul"
    ],
    "Properties": [
        {
            "filter": {
                "isRequired": false
            },
            "displayName": "Nome",
            "name": "usuar_mestre_nom_usuario",
            "description": "Nome",
            "type": "string"
        },
        {
            "filter": {
                "isRequired": false
            },
            "displayName": "Usuário",
            "name": "usuar_mestre_cod_usuario",
            "description": "Usuário",
            "type": "string"
        },
        {
            "filter": null,
            "displayName": "E-Mail Local",
            "name": "usuar_mestre_cod_e_mail_local",
            "description": "E-Mail Local",
            "type": "string"
        },
        {
            "filter": null,
            "displayName": "Tipo Usuário",
            "name": "usuar_mestre_ind_tip_usuar",
            "description": "Tipo Usuário",
            "type": "string"
        },
        {
            "filter": null,
            "displayName": "Favoritos do usuário",
            "name": "Favoritos",
            "description": "Lista de Favoritos do usuário",
            "type": "array",
            "Properties": [
                {
                    "filter": null,
                    "displayName": "Chave Função",
                    "name": "usuar_fav_cod_function",
                    "description": "Chave Função",
                    "type": "string"
                },
                {
                    "filter": null,
                    "displayName": "Nome programa favorito",
                    "name": "nome_do_favorito",
                    "description": "Nome do programa favorito",
                    "type": "string"
                },
                {
                    "filter": null,
                    "displayName": "Nome modulo",
                    "name": "nome_do_modulo_favorito",
                    "description": "Nome do modulo",
                    "type": "string"
                }
            ]
        },
        {
            "filter": null,
            "displayName": "Grupos do usuário",
            "name": "Grupos",
            "description": "Lista de grupos do usuário",
            "type": "array",
            "Properties": [
                {
                    "filter": null,
                    "displayName": "Grupo",
                    "name": "grp_usuar_cod_grp_usuar",
                    "description": "Grupo Usuários",
                    "type": "string"
                },
                {
                    "filter": null,
                    "displayName": "Descrição",
                    "name": "grp_usuar_des_grp_usuar",
                    "description": "Descrição",
                    "type": "string"
                }
            ]
        },
        {
            "filter": null,
            "displayName": "Impressoras do usuário",
            "name": "impressoras",
            "description": "Lista de impressoras do usuário",
            "type": "array",
            "Properties": [
                {
                    "filter": null,
                    "displayName": "Impressora",
                    "name": "impressora_nom_impressora",
                    "description": "Impressora",
                    "type": "string"
                },
                {
                    "filter": null,
                    "displayName": "Descrição",
                    "name": "impressora_des_impressora",
                    "description": "Descrição",
                    "type": "string"
                },
                {
                    "filter": null,
                    "displayName": "Tipo Impressora",
                    "name": "impressora_cod_tip_imprsor",
                    "description": "Tipo Impressora",
                    "type": "string"
                },
                {
                    "filter": null,
                    "displayName": "Layout de impressora",
                    "name": "layout",
                    "description": "Lista de layouts de impressora",
                    "type": "array",
                    "Properties": [
                        {
                            "filter": null,
                            "displayName": "Layout Impressão",
                            "name": "layout_impres_cod_layout_impres",
                            "description": "Layout Impressão",
                            "type": "string"
                        },
                        {
                            "filter": null,
                            "displayName": "Tipo Impressora",
                            "name": "layout_impres_cod_tip_imprsor",
                            "description": "Tipo Impressora",
                            "type": "string"
                        },
                        {
                            "filter": null,
                            "displayName": "Número Layout",
                            "name": "layout_impres_num_id_layout_impres",
                            "description": "Número Layout",
                            "type": "number"
                        }
                    ]
                }
            ]
        },
        {
            "filter": null,
            "displayName": "Estatiticas do usuário",
            "name": "Estatisticas",
            "description": "Lista de Estatiticas do usuário",
            "type": "array",
            "Properties": [
                {
                    "filter": {
                        "isRequired": false
                    },
                    "displayName": "Data do ultimo acesso",
                    "name": "tt-estat_dat_ultimo_acesso",
                    "description": "Data do ultimo acesso",
                    "type": "date"
                },
                {
                    "filter": {
                        "isRequired": false
                    },
                    "displayName": "Ultimo acesso bloqueado",
                    "name": "tt-estat_dat_ultimo_acesso_bloqueado",
                    "description": "Ultimo acesso bloqueado",
                    "type": "date"
                },
                {
                    "filter": {
                        "isRequired": false
                    },
                    "displayName": "Ultimo acesso bloqueado",
                    "name": "tt-estat_qtd_acesso_bloqueado",
                    "description": "Ultimo acesso bloqueado",
                    "type": "number"
                }
            ]
        }
    ],
    "parameters": [
        {
            "displayName": "Usuário inicial",
            "name": "usuarIni",
            "type": "string",
            "MultiValue": false
        },
        {
            "displayName": "Usuário final",
            "name": "usuarFim",
            "type": "string",
            "MultiValue": false
        },
        {
            "displayName": "Lista Usuário que não possua grupo",
            "name": "listUsarSemGrupo",
            "type": "boolean",
            "MultiValue": false
        },
        {
            "displayName": "Lista somente Impressora principal",
            "name": "listSomentePrincipal",
            "type": "boolean",
            "MultiValue": false
        }
    ],
    "schemaUrl": "http://localhost:8080/api/btb/v1/svUsuarDetail/objectschema"
}

{
    "data": [
        {
            "impressoras": [
                {
                    "layout": [
                        {
                            "layout_impres_num_id_layout_impres": 1,
                            "layout_impres_cod_layout_impres": "Padrão_080",
                            "layout_impres_cod_tip_imprsor": "DatasulGDI"
                        },
                        {
                            "layout_impres_num_id_layout_impres": 2,
                            "layout_impres_cod_layout_impres": "Padrão_132",
                            "layout_impres_cod_tip_imprsor": "DatasulGDI"
                        },
                        {
                            "layout_impres_num_id_layout_impres": 3,
                            "layout_impres_cod_layout_impres": "Padrão_132_compr",
                            "layout_impres_cod_tip_imprsor": "DatasulGDI"
                        },
                        {
                            "layout_impres_num_id_layout_impres": 4,
                            "layout_impres_cod_layout_impres": "Padrão_172",
                            "layout_impres_cod_tip_imprsor": "DatasulGDI"
                        },
                        {
                            "layout_impres_num_id_layout_impres": 5,
                            "layout_impres_cod_layout_impres": "Padrão_172_P",
                            "layout_impres_cod_tip_imprsor": "DatasulGDI"
                        },
                        {
                            "layout_impres_num_id_layout_impres": 6,
                            "layout_impres_cod_layout_impres": "Padrão_215_P",
                            "layout_impres_cod_tip_imprsor": "DatasulGDI"
                        },
                        {
                            "layout_impres_num_id_layout_impres": 7,
                            "layout_impres_cod_layout_impres": "Padrão_255_P",
                            "layout_impres_cod_tip_imprsor": "DatasulGDI"
                        }
                    ],
                    "impressora_nom_impressora": "xxx",
                    "impressora_des_impressora": "xxx",
                    "impressora_cod_tip_imprsor": "DatasulGDI"
                }
            ],
            "Favoritos": [
                {
                    "nome_do_modulo_favorito": "Menu",
                    "nome_do_favorito": "Programa Produto Datasul",
                    "usuar_fav_cod_function": "bas_prog_dtsul"
                },
                {
                    "nome_do_modulo_favorito": "Custos",
                    "nome_do_favorito": "Atualização Preços Itens",
                    "usuar_fav_cod_function": "cs0303"
                },
                {
                    "nome_do_modulo_favorito": "Bancos Históricos",
                    "nome_do_favorito": "Tarefas Retorno Históricos ADM",
                    "usuar_fav_cod_function": "fnc_transfer_bcos_historicos_retorno"
                },
                {
                    "nome_do_modulo_favorito": "Configurações",
                    "nome_do_favorito": "Propriedades OAuth2",
                    "usuar_fav_cod_function": "propriedades-oauth2"
                },
                {
                    "nome_do_modulo_favorito": "Chão de Fábrica",
                    "nome_do_favorito": "Consulta Item Controle",
                    "usuar_fav_cod_function": "sf0507"
                },
                {
                    "nome_do_modulo_favorito": "Chão de Fábrica",
                    "nome_do_favorito": "Acompanhamento Medição",
                    "usuar_fav_cod_function": "sf7220"
                },
                {
                    "nome_do_modulo_favorito": "Básico (NPS)",
                    "nome_do_favorito": "Relatorio Teste 02 do tReports",
                    "usuar_fav_cod_function": "tReport.teste02"
                }
            ],
            "Estatisticas": [
                {
                    "tt-estat_qtd_acesso_bloqueado": 1287,
                    "tt-estat_dat_ultimo_acesso_bloqueado": "2023-11-23T00:00:00.000-03:00",
                    "tt-estat_dat_ultimo_acesso": "2023-12-04T00:00:00.000-03:00"
                }
            ],
            "usuar_mestre_nom_usuario": "Super Usuário",
            "usuar_mestre_cod_usuario": "super",
            "usuar_mestre_ind_tip_usuar": "Super",
            "usuar_mestre_cod_e_mail_local": "adm@totvs.com.br",
            "Grupos": [
                {
                    "grp_usuar_cod_grp_usuar": "*",
                    "grp_usuar_des_grp_usuar": "Todos os Usuários"
                },
                {
                    "grp_usuar_cod_grp_usuar": "sop",
                    "grp_usuar_des_grp_usuar": "Customizador"
                },
                {
                    "grp_usuar_cod_grp_usuar": "sup",
                    "grp_usuar_des_grp_usuar": "sup"
                }
            ]
        }
    ]
}

{
    "data": [
        {
            "label": "Admin",
            "key": "Admin"
        },
        {
            "label": "Comun",
            "key": "Comun"
        },
        {
            "label": "Super",
            "key": "Super"
        },
        {
            "label": "Supervisor",
            "key": "Supervisor"
        }
    ]
}

<style>

.custom-button {
	position: absolute;
    top: 50px;
    right: 35px;
}

.page-metadata div {
	float: none !important;
	margin: 4px 0 0 0 !important;
}

<!********TIRA O MENU LATERAL*********-->
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;
}

.aui-tabs.horizontal-tabs>.tabs-menu>.menu-item.active-tab a::after { 
	background: #FF9900; !important 
}

.menu-item.active-tab { 
	border-bottom: none !important; 
}
<!****************************-->

</style>