Introdução

O projeto TOTVS Smart Analytics é um projeto padrão que oferece uma solução de inteligência de negócios que abrange uma gama de possibilidades e visões que apoiam a tomada de decisão dos usuários finais. Mas ao adquirir o produto, o cliente pode sentir a necessidade de realizar customizações, como por exemplo, criar novos relatórios ou incluir novos campos.

Este artigo trata sobre as possíveis customizações que podem ser implementadas no projeto TOTVS Smart Analytics. Existem 2 casos diferentes de customização. Em uma delas, o usuário deseja customizar o projeto padrão, de forma a incluir novos campos e/ou novas tabelas, para então criar novas métricas e novos relatórios, e dashboards, com estes itens criados no projeto. Em outra situação, o usuário pretende criar relatórios ou dashboards novos, baseados no projeto padrão. Este último caso, não requer alterações no projeto padrão, ou seja, se este for o caso, não é necessário customizar o projeto, mas sim, apenas criar os relatórios/dashboards diretamente no front-end.

Customização de Relatórios e Dashboards

No Smart Analytics pode-se customizar métricas, relatórios e dashboards, independente se o usuário customizou novos campos ou Datasets, anteriormente. No front-end, podemos ter os seguintes casos de customização: 

• Criação de novas métricas: Para criar uma métrica a partir de uma Fato criada na modelagem, seguindo os passos anteriores, disponível nesta publicação Como utilizo a opção Salvar Como para um relatório padrão do TOTVS Smart Analytics? Além disso, é possível criar novas métricas calculadas, ou seja, a partir de cálculos entre outras métricas já existentes, a partir da opção Create Metric.

• Criação de novos relatórios: Se deseja alterar um relatório existente, primeiramente salve uma cópia conforme disponível neste link Como criar métricas no TOTVS Smart Analytics. Também, é possível criar um relatório do zero, a partir da opção Create Report.

• Criação de novos dashboards: Para alterar um dashboard existente, primeiro salve uma cópia deste, como mostrado nesta FAQ: Como copio uma aba de dashboard padrão do TOTVS Smart Analytics para outro dashboard criado pelo usuário?. Ou, pode-se criar um dashboard do zero, a partir da opção Add Dashboard: Como crio um Dashboard? .

Customização do Projeto - Modelagem e ETL

Nesta situação serão analisados 3 cenários possíveis de customização no Smart Analytics. Estudaremos, a seguir, cada um destes cenários.

Cenário 1                   

O cliente necessita de campos extras em um Dataset, seja este fato ou dimensão, no projeto padrão do Smart Analytics é possível configurar oscampos livres. Estão disponíveis 10 campos livres para cada Dataset, sendo que nas tabelas fatos, são 5 campos livres que representam métricas, 3 campos livres que representam data e 2, que representam atributos. Para as dimensões, os 10 campos livres são do tipo atributo. Estes campos livres tem como objetivo disponibilizar a inclusão de campos extras na extração de dados, possibilitando ao cliente incluir novos campos, seja ele um indicador ou um atributo, que não são atendidos pelo projeto padrão. Assim, geram-se novos indicadores que agregam novas informações e que poderão auxiliar na tomada de decisão dos clientes que utilizam o produto TOTVS Smart Analytics.

Ao utilizar os campos livres, o usuário não precisará implementar nenhuma customização no projeto TOTVS Smart Analytics. Observe, então, a facilidade que os campos livres oferecem aos usuários. Portanto, sempre que possível solucionar os problemas que necessitam de customizações utilizando os campos livres, ganha-se mais praticidade e agilidade na manutenção e atualização do produto padrão TOTVS Smart Analytics.

Cenário 2) Os 10 campos livres não são suficientes, e o cliente necessita de um ou mais campos em um Dataset existente, sendo este fato ou dimensão.

Cenário 3) O que será customizado condiz com um assunto totalmente diferente do que já existe no projeto padrão e será necessário criar um novo Dataset ou mais, sendo fato ou dimensão. Dentro deste cenário, há três possibilidades diferentes:

• a) O cliente deseja criar Datasets do tipo fato, e o relaciona com uma ou mais dimensões existentes no projeto padrão.
• b) O cliente deseja criar Datasets do tipo dimensão, e o relaciona com uma ou mais fatos já existentes no projeto padrão.
• c) O cliente deseja criar alguns Datasets no projeto, sendo fatos e/ou dimensões. E dessa forma, os relacionamentos criados são apenas entre Fato(s) e Dimensão(ões) criados pelo cliente, sem interferir com os Datasets do projeto padrão.

A seguir, temos os passos necessários para realizar uma customização no projeto do Smart Analytics, abordando tanto modelagem e ETL, quanto relatórios e dashboards. Se o objetivo for customizar modelagem e/ou ETL, recomenda-se fortemente, que antes de seguir os próximos passos, o cliente crie uma cópia local do projeto, para que as alterações sejam realizadas no projeto próprio, pois poderão ocorrer atualizações, no projeto padrão, que substituiriam as customizações realizadas.

Modelagem

No arquivo .mdl (na pasta model) será necessário:

Cenário 1) Nada será alterado.

Cenário 2) Crie um novo campo no Dataset desejado, escolhendo-se o tipo fato ou atributo.

Cenário 3.a) Adicione um novo Dataset, incluindo-se campos do tipo fato, e se necessário, do tipo atributo, também. Em seguida, adiciona-se uma relação entre a(s) dimensão(ões) desejada(s), e esta nova fato.

Cenário 3.b) Adicione um novo Dataset, incluindo-se campos do tipo atributo, apenas (pois assim, o Dataset será definido como uma dimensão). Em seguida, adiciona-se uma relação entre esta nova dimensão e a fato desejada.

Cenário 3.c) Adicionar novos Datasets, tanto fato(s), como dimensão(ões), em seguida, adiciona-se uma relação entre a(s) dimensão(ões) e a(s) fato(s) criadas.

ATENÇÃO: Ao finalizar qualquer um destes passos, deve-se salvar e publicar a nova modelagem para a nuvem do GoodData, antes de seguir os próximos passos. Para isso, clique em "Publish Model to Server, localizado no Menu Details à direita.

Neste momento, a seguinte tela é exibida informando as alterações que serão realizadas na modelagem que se encontra na nuvem.

Além disso, também é possível visualizar e copiar o script MAQL que adicionará os campos e/ou tabelas customizados. Para visualizar, expanda a seta de "Advanced e clique em "View MAQL":

ETL 

Nos arquivos .grf (na pasta graph) será necessário: cenario 2 e 3 precisam ser em novo projeto. NÃO utilizar o projeto padrão.

Cenário 1) Nada será alterado.

Cenário 2) Adicionar os novos campos no metadado, referente ao graph do Dataset alterado na modelagem.

Cenário 3.a) Criar um novo graph para o carregamento da fato criada. Se foi criada mais de uma fato, criar um graph por fato. Não será necessário alterar o graph da dimensão associada.

Cenário 3.b) Criar um novo graph para o carregamento da dimensão criada. Se foi criada mais de uma dimensão, criar um graph por dimensão. O graph da fato que foi relacionada à esta dimensão, deve ser atualizada, de forma a incluir o novo campo no metadado, além de adicionar a referência no mapeamento do novo campo.

Cenário 3.c) Criar um novo graph por dataset criado.

ATENÇÃO: Recomenda-se que antes de alterar um graph existente, salve uma cópia do projeto em seu projeto local, e realize as mudanças em seu projeto local. A partir do momento que o cliente criar um novo graph, altere um metadado ou altere um graph, este graph passa a ser de total responsabilidade do cliente, no que se refere à manutenção e às atualizações do projeto.

Agent 

No arquivo my.properties será necessário:

Cenário 1) Nada será alterado.

Cenário 2) Incluir o campo na busca existente, referente ao Dataset alterado.

Cenário 3.a) Incluir a busca do Dataset criado.

Cenário 3.b) Incluir a busca do Dataset criado. Além disso, será necessário incluir o novo campo, na busca já existente, referente à dimensão relacionada.

Cenário 3.c) Incluir as buscas de todos os Datasets criados.

ATENÇÃO: Ao selecionar os campos na busca que será criada ou alterada, a ordem destes, devem ser a mesma ordem dos campos no metadado criado ou alterado no passo anterior.