Instalar e gerenciar soluções no Sankhya Om

Entenda as funções da nova tela no Sankhya Om chamada Minhas soluções

Está disponível uma nova tela no Sankhya Om chamada Minhas Soluções, que traz diversas melhorias no processo de instalação e gerenciamento de soluções. Nela os clientes poderão visualizar, instalar e administrar as soluções disponíveis e já instaladas de forma mais simples, rápida e centralizada.

Essa tela foi desenvolvida para otimizar o tempo, reduzir etapas manuais e oferecer mais controle e visibilidade sobre os recursos disponíveis no sistema, promovendo uma experiência mais fluida e eficiente na gestão de soluções. Neste guia, você aprenderá como utilizar esse novo recurso, quais são os requisitos necessários e como gerenciar as suas soluções.

Obtendo acesso a Tela

Para conseguir realizar as operações nessa tela é importante possuir um Sankhya ID vinculado a Licença do Cliente.

Isso garante rastreabilidade e compliance, identificando corretamente os usuários que estão realizando qualquer ação relacionada as Soluções oferecidas.

Existem 2 formas de conseguir o nível de acesso necessário:

  1. O Administrador do Sankhya ID pode conceder acesso ao usuário através do site https://account.sankhya.com.br/ menu Gestão de Acessos.

    1. Localizar o usuário e atribuir a permissão de Usuário no Sankhya OM, ou;

    2. Adicionar um usuário com a permissão de Usuário no Sankhya OM:

  2. Caso o usuário possua um usuário único (esse usuário não pode ser compartilhado) no Sankhya Om, ele pode realizar o login com o Sankhya ID, e seguir os passos após o login, dessa forma ele irá obter automaticamente esse acesso.

  3. Para conseguir realizar a operação de instalação existe no Cadastro de Usuário do Sankhya Om uma segunda validação, reforçando a segurança dessa ação. É necessário adicionar ao usuário a permissão "Permite instalar pacote Sankhya Place?" para que o mesmo consiga instalar a solução via tela "Minhas soluções", conforme imagem abaixo:

Visualizando as soluções disponíveis

Ao acessar a tela Minhas Soluções, o sistema solicitará suas credenciais de login para garantir o acesso seguro ao gerenciamento das suas soluções. Após a autenticação, a tela será exibida conforme o exemplo abaixo, apresentando os seguintes recursos:

✅ Listagem das soluções disponíveis para gerenciamento

  • Exibe todas as soluções associadas ao seu ambiente, tanto as já instaladas quanto as disponíveis para instalação.

🔎 Barra de pesquisa

  • Permite localizar rapidamente uma solução digitando o nome, o status (Em Período de Teste, Disponível, Ativa, etc.) ou o ID da solução.

Além disso, você conta com o ícone de ajuda ("?"), localizado na interface da tela. Ao clicar nele, é possível visualizar informações a versão do micro módulo do Place atualmente instalada.

Será apresentado um pop-up informando a versão do placemm instalada, conforme exemplo abaixo:

Status das soluções na tela "Minhas Soluções"

Dentro da tela "Minhas Soluções", você poderá visualizar todas as soluções disponíveis, cada uma com um status específico que indica sua situação atual. Abaixo, seguem os possíveis status e seus significados:

  • Disponível: A solução está disponível para instalação no seu ambiente.
  • Expirado: O período de teste da solução foi encerrado. Para continuar utilizando, será necessário entrar em contato com o desenvolvedor para renegociar o acesso.
  • Ativo: A solução está instalada e em uso no seu ambiente.
  • Em Período de Teste: A solução está liberada para uso gratuito por tempo limitado. Durante esse período, você pode instalá-la sem custo.
  • Aguardando Autorização: A instalação da solução está pendente de liberação. Para mais detalhes, consulte a seção "Instalação com autorização de customização" deste guia.
  • Atualização Pendente: Uma nova versão da solução foi disponibilizada e está pronta para ser instalada.
  • Instalar: A solução já passou pelo processo de autorização e está agora apta para ser instalada.
  • Aguardando Aprovação: Etapa em que o cliente deve validar e aprovar os scripts e dicionários de dados da solução antes da instalação no ambiente.
  • Cancelado: A solução não está mais em negociação entre ambas as partes
  • Erro: Esse status indica que ocorreu uma falha durante o processo de inicialização do add-on no ambiente do cliente. O erro impediu que o add-on fosse corretamente carregado ou executado, sendo necessária uma verificação técnica para identificar e corrigir a causa do problema. Quando ocorre erro, o sistema habilita a aba "Motivo da Falha", onde aponta o motivo do erro da inicialização do add-on.
  • Erro na instalação: Esse status indica que ocorreu uma falha durante o processo de download ou instalação do binário do add-on no ambiente do cliente. O erro pode ter sido causado por problemas de conexão, permissões insuficientes ou falhas no pacote de instalação, impedindo a conclusão correta do processo.

Como instalar uma solução no seu ambiente

Para instalar uma solução no seu ambiente, ela deve estar com o status: Disponível ou Em Período de Teste. Após encontrar a solução que deseja pela solução clique no botão "Ver detalhes", que o sistema apresentará um pop-up com as seguintes informações sobre a solução:

  • Título da solução: Exibe o nome da solução e o nome do desenvolvedor ou empresa responsável por ela.

  • Abas de Informações:

  • Informações: É nessa aba que você consegue visualizar as informações mais detalhadas da solução, como descrição, id da solução, a versão e a última data de atualização dessa versão da solução.

  • Informações Técnicas: Traz dados mais específicos relacionados à implementação ou dependências técnicas da solução.

  • Auditoria: Permite acompanhar o histórico de instalação.

    • Quem instalou a solução
    • Data e hora
    • Status da instalação (sucesso ou falha)
  • Contato: Exibe os dados de suporte da pessoa ou empresa que desenvolveu a solução, facilitando a comunicação em caso de dúvidas ou problemas.

  • Histórico de versões: Lista todas as versões disponibilizadas da solução, permitindo a consulta de versões anteriores.

❗️

Importante

Tenha sempre em mãos as informações da solução que deseja instalar, como o seu nome e o respectivo ID. Isso facilita a busca e garante mais agilidade no processo de instalação.

Processo de Instalação: com e sem autorização de customização

No processo de instalação de uma solução, existem duas situações possíveis, dependendo da configuração do ambiente do cliente:

  • Clientes com a autorização de customização habilitada
  • Clientes sem a autorização de customização habilitada

A partir deste ponto, vamos detalhar o fluxo de instalação para ambos os casos, explicando como o sistema se comporta em cada cenário e quais etapas o usuário deve seguir para concluir a instalação com sucesso. Essa distinção é importante, pois a autorização de customização influencia diretamente na forma como a instalação é executada.

Instalação sem autorização de customização

Ao clicar na solução, o pop-up será aberto com as informações da solução. Após isso clique no botão "Iniciar Download" e assim será apresentado os detalhes do processo de instalação com as etapas aos quais o sistema valida as informações referentes aos dados da solução que está sendo instalada, como: dicionário de dados e scripts de bancos.

Clique no botão "Revisar", onde o sistema apresentará um pop-up contendo as informações relacionadas aos scripts de banco de dados que serão executados no ambiente do cliente.

❗️

Importante

Se algum script de banco de dados contiver comandos de alteração em tabelas nativas de grande volume, recomendamos efetuar a instalação desse add-on em um período de menor utilização do sistema.

Aprovação do processo de instalação

Ao clicar no botão "Aprovar", o sistema finaliza o processo de instalação do add-on, e uma mensagem de conclusão será exibida no pop-up, conforme o exemplo abaixo:

Feita a instalação clique no botão "Fechar Detalhes". Dessa forma você conseguirá visualizar os botões de ação rápida:

  • Desinstalar: Este efetua a desinstalação da solução em seu ambiente;
  • Baixar log: Caso ocorra algum erro no processo da instalação, este botão irá te direcionar para a tela "Administração do servidor" onde conseguirá efetuar o download do log.
  • Reiniciar: Este botão efetua a reinicialização do add-on instalado, caso haja algum erro referente a inicialização do mesmo.
  • Reiniciar DD: Este botão efetua a reinicialização do dicionário de dados do add-on instalado, caso haja algum erro referente a inicialização do dicionário de dados.

Após a instalação, você consegue acessar a aba "Auditoria" da solução e visualizar quem e quando efetuou a instalação da solução. Ao clicar no botão "X" do pop-up, você verá que o status da solução que antes estava como Disponível, agora foi alterado para Ativo, conforme imagem abaixo:

E dessa forma a solução está disponível para uso no sistema.

Instalando uma solução com conflito de dicionário de dados

Caso o cliente tente instalar uma solução que apresente conflito em dicionários de dados, o sistema exibirá a mesma etapa de aprovação, porém acompanhada das informações detalhadas sobre os dados em conflito. Nessa tela, o cliente poderá visualizar os itens conflitantes antes de prosseguir com a instalação da solução. A mesma etapa de revisar será apresentada, conforme imagem abaixo:

Quando o cliente clicar em "Revisar", o sistema apresentará a pop-up com os conflitos de dicionário de dados.

❗️

Importante

Os conflitos de dicionário de dados podem impedir o correto funcionamento e/ou a inicialização do add-on no ambiente.

Podem existir os seguintes tipos de conflitos de dicionário de dados:

  • Conflito de tabela → Já ter uma tabela criada de mesmo nome mas de outro domain.
  • Conflito de campo → Já ter um campo de mesmo nome na mesma tabela mas de outro domain.
  • Conflito de instância → Já existir uma instância de mesmo nome mas pra outro domain ou existir uma instância de mesmo nome mas para outra tabela.
  • Conflito de Opções de campo → Não possibilitar criar opções em um campo que não pertence ao domain.
  • Conflito de propriedade de campo → Não possibilitar criar opções em um campo que não pertence ao domain.
  • Conflito de ligação
    • TDDLIG (instancia orig/dest) & TDDLGC (instancia + campo orig/dest) → TDDLIG Possível conflito é existir mesma origem e destino mas de outro domain.
    • TDDLGC Executar validação anterior. O conflito é se as 4 informações estão apontando para domain diferente.

Recusa do processo de instalação

Caso queira recusar a etapa de “Validação dos Scripts”, basta clicar no botão “Recusar”. Ao fazer isso, o sistema retorna ao estágio inicial do processo, como demonstrado na imagem abaixo.

Atualização de versão de uma solução sem autorização

Ao acessar a tela “Minhas Soluções” e visualizar o status “Atualização Pendente”, significa que uma nova versão da solução está disponível para instalação. Esse status indica que há uma atualização pronta para ser aplicada, conforme ilustrado na imagem abaixo.

Quando clicar no detalhes da solução, será apresentado o botão "Atualizar" e a nova versão disponibilizada para atualização no campo "Versão disponível da solução.

Ao clicar em "Atualizar", o sistema dará início ao processo de instalação da nova versão da solução, seguindo o fluxo descrito nos itens anteriores.

Instalação com autorização de customização

Ao clicar na solução, o pop-up será aberto com as informações da solução. Após isso clique no botão "Iniciar Download" e assim será apresentado os detalhes do processo de download do binário da sua solução. Após conclusão do download do binário, será apresentado no pop-up o botão "Revisar".

Quando o cliente clicar em "Revisar", o sistema apresentará a pop-up com os conflitos de dicionário de dados.

Após clicar no botão "Aprovar" a tela "Autorização de Customizações" será aberta posicionada na aba "Botões de ação". Para efetuar a autorização da instalação da sua solução, clique na aba "Addons", conforme exemplo abaixo:

Clicando na aba "Addons", clique no botão para recarregar os dados da página e procure pelo ID da sua solução.

❗️

Importante

Os registros que estão pendentes de autorização serão destacados na cor VERMELHA, facilitando sua identificação na lista.

Além disso, para verificar qual o id da sua solução, basta acessar a tela "Minhas soluções" novamente, pesquisar pela sua solução e na aba "Informações" você verá o campo "Id"

Após localizar o ID da sua solução na aba "Addons", selecione o registro desejado e clique no botão "Gerar código de liberação". Em seguida, o sistema exibirá uma mensagem informativa, indicando que o código foi enviado para o e-mail cadastrado.

Verifique se o código de liberação foi recebido no seu e-mail. Em seguida, clique no botão "Informar código".
No pop-up que será exibido, preencha o campo "Código" com o número recebido e finalize clicando em "Liberar" para concluir a autorização da instalação.

Dessa forma sua solução está autorizada para instalação.

📘

Dica

Na seção "Itens do Addon", ao selecionar um registro da lista, você poderá visualizar todos os itens que compõem aquele addon, incluindo personalizações associadas, como botões de ação, regras de negócios, callbacks, dashboards e relatórios.

Caso o addon inclua esse tipo de recurso, eles serão listados nessa área, permitindo que você saiba exatamente o que será aplicado em seu ambiente no momento da instalação. Essa visualização ajuda a garantir mais transparência e controle sobre as alterações que serão feitas no sistema.

Acesse novamente a tela "Minhas Soluções" e pesquise pela sua solução. O status dela deve ser apresentado como "Instalar", conforme o exemplo abaixo:

Acesse a solução e o botão "Iniciar Instalação" deve estar disponível na tela.

Ao clicar no botão "Iniciar Instalação" o processo de instalação da solução será efetuado.

Após a finalização da instalação, os botões de ação disponibilizados pela solução estarão visíveis e prontos para uso, conforme descrito na seção "Instalação sem autorização de customização" deste guia. Com isso, a instalação está concluída e sua solução está pronta para ser utilizada no ambiente.

Atualização de versão de uma solução com autorização