Buscar K
Aparência
Templates e linhas de produto
- Tipo
- Como fazer
- Para
- Parceiro whitelabel
- Na tela
- HEC › Recursos e Permissões › Templates › Gerenciar Templates
Um template empacota um produto de BI pronto (Aplicações, tabelas, Dataflows, agendamentos) para instalar em quantos Tenants você quiser. A linha de produto guarda as versões desse template, diz qual é a vigente e mostra quais Tenants estão atrás. Você monta o produto uma vez num Tenant de desenvolvimento e distribui a cada cliente.
Templates › Gerenciar Templates aparece para a equipe do Cliente.
O que entra num template
Ao criar o template, você escolhe as Mesas de Aplicação e as Aplicações. O resto vem junto pelo que elas usam:
- As tabelas que as Aplicações leem.
- Os Dataflows que gravam nessas tabelas, com os Dataflows anteriores de que eles dependem.
- Os agendamentos desses Dataflows.
- As variáveis globais que os Dataflows usam, sem os valores.
- As conexões de dados, só como referência, sem login nem senha.
Uma tabela que nenhuma Aplicação usa não entra. Um Dataflow só entra se grava numa tabela que uma Aplicação escolhida lê: um Dataflow novo que ainda não alimenta nenhum Dashboard fica de fora, mesmo pronto.
Cadastros entram com a estrutura (campos, validações, referências) e sem os registros. Cada Tenant começa com o Cadastro vazio.
Criar uma linha de produto
- Em Gerenciamento de Templates, clique em Criar Linha de Produto.
- Dê um nome, como
Varejo Premium, e uma descrição. - Escolha o Modo, que decide o que o cliente final pode editar depois de instalado (veja Proteção):
- Pacote (protegido): o que veio do template só muda por uma nova instalação.
- Molde (editável após instalar): um ponto de partida que o cliente trabalha.
- Livre (vira do tenant ao instalar): uma cópia única, sem vínculo com o template.
Todo template precisa de uma linha. Um template antigo sem linha aparece em Templates Órfãos e não instala até ser vinculado a uma.
Criar um template
- Monte e teste o produto num Tenant de desenvolvimento.
- Em Gerenciamento de Templates, clique em Criar novo Template.
- Preencha Nome do Template e Descrição, e escolha a Linha.
- Em Mesas e Aplicativos, marque o que entra.
- Escreva as Notas da Versão e salve.
O template guarda o estado daquele momento. Mudanças posteriores no Tenant de desenvolvimento não alteram o template até você criar uma versão nova.
Para que o mesmo template sirva a clientes diferentes, use variáveis globais nos Dataflows, como a URL da API ou o CNPJ do cliente. Cada Tenant informa os valores na instalação. As variáveis são criadas no HorusETL. Veja HorusETL.
Publicar uma versão nova
- Faça as mudanças no Tenant de desenvolvimento.
- Abra a linha, vá ao template vigente e clique em Nova Versão do Vigente, ou em Editar Conteúdo do Template (Nova Versão) para trocar as Mesas e Aplicações.
- Escreva as Notas da versão (opcional), deixe marcado Definir como versão vigente da linha e clique em Salvar Nova Versão.
A versão nova não chega sozinha a nenhum Tenant. Para levá-la, instale pela aba Tenants da linha (veja a próxima seção). Uma versão salva sem ser vigente fica como descontinuada até alguém clicar em Definir Vigente nela.
A página da linha tem as abas Templates, Tenants, Documentação e Histórico.
Instalar
Num Tenant
Ao criar um Tenant, escolha o template no próprio formulário. Num Tenant que já existe, abra o cadastro dele, aba Templates, e clique em Instalar template:
- Em Escolha o template, selecione a versão. A tela mostra os Apps, as variáveis e as conexões que ele instala.
- Em Escolha o agente, selecione o Agente ETL que vai rodar as cargas.
- Preencha as variáveis e o mapa de conexões (veja abaixo).
- Em Como instalar, escolha Instalar por cima ou Espelhar template.
- Confirme.
Instalar por cima cria e atualiza o que vem no template. O que já existe no Tenant e não está no template fica como está.
Em vários Tenants
Na aba Tenants da linha, os Tenants com versão antiga aparecem com a marca Desatualizado. Selecione os Tenants e clique em Instalar (N). Na janela, escolha Instalar por cima ou Espelhar e confira a prévia de cada Tenant. Se algum falhar, Executar os restantes continua dos que faltam.
Mapa de conexões
As conexões de um template são as do Tenant de desenvolvimento. Ao instalar, cada uma precisa apontar para uma conexão do Tenant de destino. Na seção Conexões, cada conexão do template tem o seletor Usar neste tenant, com:
- as conexões compatíveis do Agente ETL escolhido;
- Criar nova conexão, que cria uma conexão vazia no Tenant. Se a conexão do template é de banco SQL, dá para escolher o tipo da nova, como um template em Firebird num cliente em SQL Server.
O seletor já vem com uma sugestão, nesta ordem: a conexão usada nas instalações anteriores do mesmo template no Tenant, a conexão de mesmo nome no agente, ou criar nova. Se o agente tem conexões compatíveis e nenhuma sugestão serve, a escolha é obrigatória.
Os nós de extração passam a usar o tipo da conexão escolhida, e a tela avisa quando o banco muda. Se a consulta muda entre bancos, o template pode trazer um SQL por tipo de banco em cada nó. Nós que escolhem a conexão por variável ficam fora do mapa e seguem o valor da variável.
Numa atualização, o mapa volta com as escolhas da instalação anterior. Confira antes de aplicar, principalmente se o cliente trocou de banco. Na instalação em vários Tenants, a execução fica bloqueada enquanto algum Tenant marcado tem conexão sem destino.
Espelhar
Instalar por cima nunca remove nada. Com o tempo, o Tenant acumula o que saiu do produto: Aplicações descontinuadas, restos de versões antigas. Espelhar faz a instalação e depois remove do Tenant o conteúdo de template que não está na versão instalada, deixando o Tenant igual ao template.
| É removido | Quando |
|---|---|
| Aplicação | Não há Aplicação de mesmo nome, na mesma Mesa, no template |
| Tabela (menos Cadastros) | Não há tabela de mesmo nome, na mesma Mesa, no template |
| Dataflow | Não há Dataflow de mesmo nome, na mesma Mesa, no template |
| Mesa | Ficou vazia depois das remoções |
| Agendamento | Todos os Dataflows que ele dispara foram removidos |
| Datamart | Nenhuma das tabelas dele ficou |
O Espelhar só remove o que veio de um template. O que o Tenant publicou por conta própria, mesmo na Mesa do template, fica, junto com a Mesa. Objetos instalados por outro template no mesmo Tenant são removidos se não estão no template que está sendo instalado.
Ficam sempre: conexões, variáveis, os registros dos Cadastros, permissões, alertas, favoritos e Dashboards pessoais. A exceção são os alertas de uma Aplicação removida, que saem junto com ela.
Antes de executar, a tela mostra o que vai sair, por tipo e nome. A prévia pode listar a mais (uma Mesa ou um agendamento que a própria instalação vai manter), nunca a menos. O que sai vai para a Lixeira e pode ser restaurado por 90 dias.
Se a instalação vai sobrescrever objetos de outra linha de produto, como na troca de um plano básico pelo completo, a tela lista esses objetos e pede confirmação. Numa linha em modo Molde, a reinstalação pergunta se deve Manter o que já foi trabalhado (só cria o que falta) ou sobrescrever com o template.
Proteção e customização
Numa linha em modo Pacote, as Aplicações, tabelas e Dataflows instalados pelo template só mudam por uma nova instalação. Editar, excluir ou publicar por cima é recusado com a explicação. A marca Do template aparece no HorusETL, no HorusDW e no HEC. Assim o cliente final não quebra o produto, e as versões novas chegam sem conflito.
A Mesa segue os objetos que guarda: enquanto houver objeto protegido nela, não dá para renomear nem excluir a Mesa, porque a próxima instalação a encontra pelo nome. Ícone, cor e Mesa fechada ficam livres.
Customizar para um cliente
Para mudar algo só para um cliente sem perder as atualizações:
- No Tenant do cliente, clone o objeto do template, como o Dataflow
Fato_Vendas, para a Minha Mesa. - Renomeie o clone para um nome único, como
Fato_Vendas_Custom, e edite. - Publique o clone como novo, na mesma Mesa do original. Publicar substituindo o original é recusado.
Na versão seguinte do template, o original é atualizado e o clone fica como o cliente deixou. O Espelhar não o remove. Se o cliente não quer ver a Aplicação original ao lado da dele, esconda a original do catálogo com Oculto no DataViz. Veja Conteúdo.
O que libera a edição
| Onde | Como | Alcance |
|---|---|---|
| Tenant | Liberar edição de objetos de template, em Avançado › Permissões & Acesso do Tenant ou do Cliente | Tudo o que veio de template naquele Tenant |
| Linha de produto | Modo Molde ou Livre | Tudo o que a linha já instalou, em todos os Tenants, na hora, sem reinstalar |
| Objeto | Desvincular do template, nas listas de Conteúdo | Só aquele objeto |
O que foi instalado em modo Livre continua editável mesmo se a linha voltar para Pacote depois. Um objeto desvinculado volta a ser sobrescrito se o mesmo template for instalado de novo e houver objeto com o mesmo nome na mesma Mesa. Para manter a edição, renomeie depois de desvincular.
Se der errado
Sem linha de produto. Vincule em Templates, na lista Templates Órfãos. O template não tem linha. Abra a linha certa e vincule o template a ela.
Escolha a linha de produto do template! Todo template novo precisa de linha. Escolha uma ou crie com Criar Linha de Produto.
Um Dataflow não veio no template. Ele não grava em nenhuma tabela usada pelas Aplicações escolhidas. Use a tabela dele numa dessas Aplicações e crie uma versão nova.