Formulário para Documentação de Objetos

Identificação
Parceiro:
Número da FAP: Número da OS:

Descrição

Tabela para Detalhamento do Objeto

Detalhes do Objeto
Nome do Objeto
Tipo Criação de Dashboard
Autor Allyson S Faria
Email
Data do Documento 15/04/2021
Objetivo
Demonstrar como criar Componentes BI no Sankhya-W
Observações
Todos os códigos para geração dos BI de Exemplo se encontrarão no próprio componente
BI no Sankhya, categoria: Exemplos Treinamento BI

1
Formulário para Documentação de Objetos

Abrindo a tela do Construtor de Componentes BI.

Digitar na pesquisa do sistema o nome da tela para abri-la.

Composição da Tela de Construtor de Componentes BI.

Indicado pela seta temos o botão de Novo onde podemos criar um novo componente bi.

Do lado Esquerdo da tela ficam localizados os filtros. Nessa parte temos o Filtro por Categoria, essa
categoria é atualizada conforme o usuário vai inserindo novas categorias durante a criação dos seus
Componentes BI.

Iniciando um novo Componente BI.

Clique no botão de +

2
Formulário para Documentação de Objetos

Composição da Tela de Criação de Componente

Campo / Sessão Descrição

Título Campo obrigatório para futuras pesquisas

Campo obrigatório, pois facilita ao usuário

Categoria buscar um grupo de componentes que estejam
vinculados ou são parecidos entre si

Interessante colocar uma breve descrição do

Observação funcionamento do Componente que está sendo
desenvolvido

Marcando esse campo o sistema irá entender

que o componente em si se trata de um Cartão
Inteligente portando o mesmo será alocado
Cartão Inteligente
para a pata de Cartões Inteligentes do Sankhya,
permitindo o usuário liberar acesso a ele na tela
principal do sistema.

Tempo p/ Atualização Necessário para fazer com que dashboards

específicos atualizem os dados de tempo em
tempo sem a interação do usuário

3
Formulário para Documentação de Objetos

Campo / Sessão Descrição

Local onde o usuário poderá realizar ajustes no

Ferramentas
layout do componente BI

É onde fica localizado a lista de Componentes

Componentes que o usuário tem acesso para criação.

São Divididos em Controles / Gráficos

Principal Local onde deverá ser inserido os componentes

Nível Local onde é possível inserir multiníveis

Parâmetros É onde será inserido os filtros que serão

contidos no Dashboard

Configurações / Variáveis / Argumentos Todos servem para configurações específicas.

4
Formulário para Documentação de Objetos

Usando a Aba Ferramentas

Digitando o número de colunas e linhas a qual deseja repartir a tela e clicando em um dos 2 botões
indicados pela seta podemos dividir a tela horizontalmente ou verticalmente, conforme exemplo da
aba Principal.

1 – Divisão selecionada, podemos reparar que a cor muda ficando com uma tonalidade amarelada,
com ela selecionada dessa forma podemos excluir clicando na Latinha de Lixo da aba Ferramentas ou
clicando em volta dela (moldura externa), e na vassourinha resetar a visualização do Painel

2 – Divisão não selecionada

5
Formulário para Documentação de Objetos

Componente TABELA

Clicar sobre o componente Tabela e arrastar para a aba Principal. Para iniciar a configuração clicar no
símbolo de edição conforme mostra a imagem.

Clicar no botão Editar para podermos inserir o nosso código SQL que será utilizado no componente.

6
Formulário para Documentação de Objetos

Clicar em Avançado, logo após podemos substituir tudo que irá aparecer no retângulo na parte de
baixo da tela colando nosso código SQL. Após isso deve-se clicar em OK.

Nome: Campo onde irá trazer o nome do campo ou o alias definido no código SQL evitar caracteres
especiais, porém underline é permitido para separação do nome do campo, um exemplo seria o
nome do campo CGC_CPF que mesmo tendo underline não ocorre nenhum problema.

Descrição: Nesse campo poderá ser definido o nome que irá aparecer na visualização do BI, podendo
conter caracteres especiais, espaço e tudo mais.

Tipo: Definirá qual o tipo de dados um determinado campo é, caso detecte de forma errado só
alterar o valor desse campo.

Visível: Serve para falar para o componente se o campo em questão deve ou não ser visto na tela.

Agregador: Serve para fazer somas os campos desejados gerando um totalizador.

Máscara: Permite colocar uma máscara em Data / Hora / Moeda / Percentual / etc...

OBSERVAÇÃO IMPORTANTE: Essas configurações desde a escolha do componente, até a inserção

do código SQL se repetirão para todos os componentes.

7
Formulário para Documentação de Objetos

Realizadas as Alterações necessárias podemos clicar em Salvar e depois em Pré-Visualizar conforme

mostrado abaixo.

Visualização do BI Tabela

Inserindo Parâmetros

Conforme dito anteriormente podemos adicionar parâmetros no componente, para que possamos
filtrar os dados a serem exibidos no Dashboard. Para isso basta clicar em + na Aba Parâmetros. Será
apresentada a seguinte tela.

Nessa tela temos alguns campos imutáveis e outros que se alteram de acordo com o Tipo de
Parâmetro escolhido. Segue adiante a explicação de cada um.

ID: Campo Obrigatório onde deverá ser colocado o nome do Parâmetro que será inserido no nosso
código SQL.

Descrição: Descrição do Parâmetro, é o que será apresentado na hora que o Componente BI for
gerado.

Requerido: Faz com que seja obrigatório o preenchimento do Parâmetro com essa opção marcada.

Salvar último valor: Faz com que o sistema grave qual foi o último valor inserido nesse parâmetro
para que o mesmo venha preenchido nas próximas visualizações.

8
Formulário para Documentação de Objetos

Tipo: O campo Tipo de divide em vários tipos, vamos ver como funciona os mais utilizados.

Tipo Descrição
Usado quando o usuário deseja criar um filtro
trazendo os valores de uma tela do Sankhya, para
Entidade / Tabela isso deve-se clicar na lupa e encontrar a tabela
desejada.
No Exemplo usaremos a tabela TSIEMP (Empresa)
Exemplo
Configuração do Parâmetro Visualização no momento da execução do BI

Código se Obrigatório Código se não Obrigatório

CODEMP = :EMPRESA ((CODEMP = :EMPRESA) OR (:EMPRESA IS NULL))

Tipo Descrição
Usado quando o usuário deseja criar um filtro por
Período período, esse filtro traz apenas a informação da
Data.
Exemplo
Configuração do Parâmetro Visualização no momento da execução do BI

Código se Obrigatório Código se não Obrigatório

BETWEEN :PERIODO.INI AND :PERIODO.FIN BETWEEN :PERIODO.INI AND :PERIODO.FIN

9
Formulário para Documentação de Objetos

Tipo Descrição
Data e Data / Hora (mesma configuração) Usado quando o usuário deseja criar um filtro por
data e data/hora.
Exemplo
Configuração do Parâmetro Visualização no momento da execução do BI

Código se Obrigatório Código se não Obrigatório

DTMOV = :DATA (DTMOV = :DATA) OR (:DATA IS NULL))
DTMOV >= :DATA
DTMOV <= :DATA

Tipo Descrição
Texto / Número inteiro / Número Decimal Usado quando o usuário deseja criar um filtro por
(configuração similar) Texto / Número inteiro / Número Decimal.
Esses campos tem um campo Valor Padrão que se
preenchido irá considerar como valor inicial do
filtro esse valor.
Exemplo
Configuração do Parâmetro Visualização no momento da execução do BI

Código se Obrigatório Código se não Obrigatório

= :TEXTO (CAMPO = :TEXTO) OR (:TEXTO IS NULL))

10
Formulário para Documentação de Objetos

Tipo Descrição
Single List Possuí 2 modos principais de uso.
Modo Texto: Devemos digitar uma sequência de
resultados que serão listados no filtro.
Modo SQL: Podemos gerar um código que trava os
valores conforme necessitamos
Exemplo
Configuração do Parâmetro Visualização no momento da execução do BI

Código se Obrigatório Código se não Obrigatório

CODEMP = :EMPRESA (CODEMP = :EMPRESA) OR (:EMPRESA IS NULL))
Exemplo Texto Exemplo SQL
1 = Empresa_1 SELECT EMP.CODEMP AS VALUE,
EMP.RAZAOABREV AS LABEL
2 = Empresa_2 FROM TSIEMP EMP
3 = Empresa_3 ORDER BY 2
Onde o código antes do = vai ser enviado O CODEMP será o VALUE que é o valor que será
para o código através do parâmetro e o enviado ao código através do parâmetro e o
nome após será exibido para o usuário RAZAOABREV será o LABEL que é o nome que será
exibido para o usuário na tela.

11
Formulário para Documentação de Objetos

Tipo Descrição
Multi List Possuí 2 modos principais de uso.
Modo Texto: Devemos digitar uma sequência de
resultados que serão listados no filtro.
Modo SQL: Podemos gerar um código que trava os
valores conforme necessitamos
Exemplo
Configuração do Parâmetro Visualização no momento da execução do BI

Código se Obrigatório Código se não Obrigatório

CODEMP IN :EMPRESA CODEMP IN :EMPRESA
Exemplo Texto Exemplo SQL
1 = Empresa_1 SELECT EMP.CODEMP AS VALUE,
EMP.RAZAOABREV AS LABEL
2 = Empresa_2 FROM TSIEMP EMP
3 = Empresa_3 ORDER BY 2
Onde o código antes do = vai ser enviado O CODEMP será o VALUE que é o valor que será
para o código através do parâmetro e o enviado ao código através do parâmetro e o
nome após será exibido para o usuário RAZAOABREV será o LABEL que é o nome que será
exibido para o usuário na tela.

12
Formulário para Documentação de Objetos

Componente TABELA DINÂMICA

O Componente tabela dinâmica é igual ao componente Tabela só mudando o componente no

momento de criar (Logo pode-se seguir o mesmo exemplo).

Visualização do BI Tabela

13
Formulário para Documentação de Objetos

Componente VALOR

O componente valor permite com que o usuário insira textos para serem visualizados na tela.

Inserindo um texto para Exemplo:

Visualizando

14
Formulário para Documentação de Objetos

Componente GEOMAPA

O componente GEOMAPA permite a visualização do resultado de uma consulta direto no mapa,

utilizado geralmente para mapear local de entrega.

Configuração

Visualização do BI

15
Formulário para Documentação de Objetos

Componente Coluna (mesma configuração para Linhas e Barras)

Irá gerar um gráfico de coluna conforme o SQL desenvolvido.

Configuração

Visualização Componente BI

16
Formulário para Documentação de Objetos

Componente PIZZA (Pizza e Donut)

O componente Pizza serve para mostrar em Percentual a diferença entre um determinado

agrupamento.

Configuração

Visualização componente BI

17
Formulário para Documentação de Objetos

Componente Velocímetro

Esse componente serve para mostrar quanto está próximo de atingir metas.

Configurações

Visualização Componente BI

18
Formulário para Documentação de Objetos

Criando link em Dashboard para acessar Subnível

Nesse dashboard iremos fazer com que o Dash principal abra um subnível.
No Primeiro Nível teremos como resultado a Quantidade de Parceiros por UF e ao clicar na UF
desejada será apresentado o segundo nível contendo o nome dos Parceiros dessa UF.

Primeiro de tudo precisa-se criar o componente desejado no Nível: Principal

No exemplo iremos utilizar como principal o Componente Tabela porem a configuração pode ser
utilizada em qualquer tipo de componente.

Código do Primeiro Nível. Tem como objetivo mostrar a QTDE de Parceiros por UF

SELECT UF.UF, COUNT(PAR.CODPARC) AS QTDE

FROM TGFPAR PAR, TSICID CID, TSIUFS UF
WHERE PAR.CODCID = CID.CODCID
AND CID.UF = UF.CODUF
GROUP BY UF.UF
ORDER BY 2 DESC

19
Formulário para Documentação de Objetos

Código do Segundo Nível. Tem como objetivo mostrar o nome dos Parceiros da UF selecionada.

SELECT UF.UF, PAR.CODPARC, PAR.NOMEPARC

FROM TGFPAR PAR, TSICID CID, TSIUFS UF
WHERE PAR.CODCID = CID.CODCID
AND CID.UF = UF.CODUF
AND UF.UF = :UF
ORDER BY 3

Para criar um novo nível podemos clicar no botão + logo do lado do Nível Principal, fazendo isso será
solicitado um nome para o novo nível. Após digitar o nome desejado pode-se clicar em OK.

Ao clicar em OK será apresentado o painel em branco para que o usuário possa adicionar novos
componentes que irão compor o próximo nível.

20
Formulário para Documentação de Objetos

Ao criar um novo Componente, devemos passar um Argumento de nível que será responsável por
abrir o subnível com as informações que nós desejamos. Nesse exemplo iremos criar um argumento
do tipo Texto com o ID UF. (Esse argumento está sendo chamado no código do subnível pelo
comando AND UF.UF = :UF.

Feito essas configurações, devemos voltar ao primeiro nível e configurar o evento para abrir o
subnível.

21
Formulário para Documentação de Objetos

Clicando em Evento e configurar conforme a imagem abaixo.

Feito isso só salvar e executar o componente para visualizar o resultado.

Ao dar duplo clique sobre uma UF será exibido o subnível.

22
Formulário para Documentação de Objetos

Criando link em Dashboard para atualizar tela detalhe

A atualização da tela detalhe serve para atualizar um subcomponente em um mesmo nível.

Iremos usar os mesmos códigos do exemplo anterior, e devemos criar uma divisão no nível principal.
1 – Componente Principal
2 – Componente Detalhe

23
Formulário para Documentação de Objetos

Abrir o componente 1 e clicar em Evento e configurar conforme a imagem abaixo e clicar em OK.
Após fazer isso basta clicar em executar e visualizar o resultado.

Visualização
Clicando na UF do componente 1 será atualizado a parte inferior na parte inferior da tela mostrando
os resultados conforme

24
Formulário para Documentação de Objetos

Criando Lançador para o Componente BI desenvolvido.

Após criar um componente devemos criar o lançador para que se possa liberar acesso aos usuários a
ele. Isso é feito na tela de CONSTRUTOR DE DASHBOARDS.

Para isso podemos fazer da seguinte forma.

Ao clicar será aberto a tela abaixo, onde deve-se clicar em “Clique aqui para criar um agora”, caso o
componente ainda não tenha nenhum lançador.

25
Formulário para Documentação de Objetos

Clicando será aberta a tela de Construtor de Dashboards, para tanto será necessário realizar algumas
configurações conforme abaixo.

1 – Digitar o nome do Dashboard

2 – Digitar o nome do componente bi que se deseja adicionar ao Dashboard e clicar em buscar.

3 – Arrastar o componente encontrado para a tela principal.

4 – Clicar em Salvar

Após isso clicar em Outras Opções e clicar em “Adicionar lançador”

26
Formulário para Documentação de Objetos

Ao clicar em Adicionar lançador será aberta a tela abaixo, nela devemos

1 – Digitar a Descrição do Dashboard.
2 – Escolher a Pasta de destino.
3 – Clicar em Concluir
Feito esses processos basta liberar acesso ao Dashboard na tela de acessos para que o usuário possa
visualizá-lo.
Observação: Quando se usa o Usuário SUP o Dashboard irá aparecer na pesquisa mesmo sem
liberação de acesso.

Visualização do Dashboard na Pesquisa

27
Formulário para Documentação de Objetos

Validação do Objeto Criado

Campinas – SP, 18 de Abril de 2021

Nome: Nome: Allyson Stefanini Faria

Implantador Consultor – Sankhya

28