Sumário
Novo Gestor de Stored Procedures – CFGX051M
Migração para o novo modelo
Nova interface
Relação de empresas
Relação de processos
Guia Empresa vs Processos
Guia Processo vs Empresas
Visualizando detalhes
Instalando pacotes de procedures
Desinstalando pacotes de procedures
Consultando o histórico de operações
Relatório de Log
Configurações adicionais da rotina

Desde o dia 06/05/2022 as stored procedures são atualizadas apenas por esta nova funcionalidade. Isso significa que os arquivos de extensão SPS e a rotina CFGX051 não recebem mais atualizações. O novo modelo é o único e exclusivo processo para atualização de stored procedures.

Novo Gestor de Stored Procedures – CFGX051M

O programa Gerenciador de procedures (CFGX051), do módulo Configurador (SIGACFG) passou por uma mudança significativa.
Uma das principais mudanças, além da interface totalmente remodelada, é o fato de não mais existirem os arquivos de pacotes com extensão SPS. Estes arquivos foram substituídos por arquivos de extensão ZSPS, que estarão embarcados no RPO. A atualização destes arquivos ocorrerá de maneira semelhante à atualização de qualquer artefato, ou seja, através de patchs de atualizações expedidos pela TOTVS.
Outra grande mudança é a integração com a Central de Atualizações para obtenção dos pacotes de procedures mais recentes homologados. Esta integração ocorrerá de maneira transparente visando facilitar o processo de atualização das procedures no ambiente. Para saber mais clique aqui.

Esta alteração não afeta:

Como as procedures são executadas;
Como são instaladas no banco;
Conteúdo das procedures e dos pontos de entradas;
Esta alteração apenas muda a interface e a forma como as procedures são distribuídas.

Migração para o novo modelo

Para preparar o ambiente e realizar a migração, tenha certeza de executar os seguintes passos:

Passo 1: Aplique a última release da Central de Atualizações. Para isso acesse a página de Release Notes e baixe o patch mais recente disponibilizado.

Mesmo que não utilize a Central de Atualizações, aplique o patch da última release disponível. Ele é imprescindível pois atualizará o RPO com a nova interface e suas funcionalidades.

Passo 2: Aplique os patchs de Expedições Contínuas dos módulos relacionados abaixo para atualizar o RPO com os pacotes ZSPS e também as rotinas vinculadas aos processos de stored procedures:

1. Versão 12.1.27
  1. FAT (Faturamento) - https://suporte.totvs.com/portal/p/10098/download#detail/954520
  2. COM (Compras) - https://suporte.totvs.com/portal/p/10098/download#detail/957277
  3. FIS (Fiscal) - https://suporte.totvs.com/portal/p/10098/download#detail/956585
  4. FIN (Financeiro) - https://suporte.totvs.com/portal/p/10098/download#detail/954746
  5. EST (Estoque) - https://suporte.totvs.com/portal/p/10098/download#detail/960571
  6. CTB (Controladoria) - https://suporte.totvs.com/portal/p/10098/download#detail/959397
2. Versão 12.1.33
  1. FAT (Faturamento) - https://suporte.totvs.com/portal/p/10098/download#detail/1039091
  2. COM (Compras) - https://suporte.totvs.com/portal/p/10098/download#detail/1039089
  3. FIS (Fiscal) - https://suporte.totvs.com/portal/p/10098/download#detail/1039088
  4. FIN (Financeiro) - https://suporte.totvs.com/portal/p/10098/download#detail/1039087
  5. EST (Estoque) - https://suporte.totvs.com/portal/p/10098/download#detail/1039086
  6. CTB (Controladoria) - https://suporte.totvs.com/portal/p/10098/download#detail/1039084

Os patchs de Expedição Contínua dos módulos acima são necessários para que o RPO seja atualizado com os pacotes de procedures no novo formato .ZSPS, além das rotinas associadas às stored procedures. A aplicação destes patchs é obrigatória, caso contrário poderão ocorrer erros durante a instalação/desinstalação de processos.

Passo 3: Acesse o programa Gerenciador de procedures, através do menu Base de Dados | Dicionário | Stored Procedure. Será apresentada a seguinte interface:
Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > worddavc93595b23c3aa2e2ab88c0fd823d291b.png

As opções disponíveis são:

Documentação: ao clicar neste botão o usuário será levado para esta documentação.
Manter: ao clicar neste botão a rotina atual, sem as novas funcionalidades, será exibida. É importante lembrar que o modelo antigo não sofrerá nenhuma atualização, isto é, não serão expedidas atualizações em arquivos SPS, somente no novo formato ZSPS.
Atualizar: ao clicar neste botão, ocorrerá o processo de migração. Serão realizados procedimentos que não poderão ser desfeitos, ou seja, após migrado não será possível voltar ao modelo antigo de gestão de procedures. Após realizada a migração para o novo modelo essa interface de migração não será exibida novamente.
Fechar: a rotina não será acionada, retornando ao menu da janela principal do Protheus.

Passo 4: Clique no botão Atualizar. O processo de migração se inicia e ao ser concluído a nova interface será apresentada.

Nova interface

A principal mudança na interface será a apresentação das empresas disponíveis no ambiente e todos os processos existentes para gerenciamento ao mesmo tempo, em uma mesma janela. Não haverá necessidade de mudança de empresa para a visualização dos seus processos.

A interface possui novos botões laterais que permitirão gerenciar os processos de maneira prática e rápida, realizando a instalação e remoção de processos com poucos cliques. Consulta e relatório de log de processamento estarão disponíveis também. Novas abas permitem uma navegação mais simples e eficiente para visualizar os processos e empresas. E os totalizadores darão um resumo de forma rápida sobre os status dos processos.

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_12-10-28.png

Relação de empresas

Aqui serão listadas todas as empresas disponíveis no ambiente. Não há necessidade de entrar no ambiente utilizando a empresa para a qual se deseja instalar/desinstalar um processo.
Será possível marcar mais de uma empresa e realizar a ação desejada de uma só vez.

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_16-58-40.png

As ações disponíveis nos botões da barra lateral são:

Instalar os pacotes selecionados nas empresas selecionadas.
Remover os pacotes selecionados das empresas selecionadas.
Marcar todas as empresas disponíveis no grid.
Desmarcar todas as empresas do grid.
Consultar o histórico de operações.
Configurações adicionais da rotina.

Relação de processos

Serão listados todos os processos disponíveis para instalação.
Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > worddav6b1e5811f6368c1d488766e5a75dc571.png

As ações disponíveis nos botões da barra lateral são:

Marcar todos os processos disponíveis no grid.
Desmarcar todos os processos do grid.

Guia Empresa vs Processos

A visão disponibilizada nesta guia baseia-se na navegação realizada entre as empresas disponíveis na relação de empresas.

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-7-12_15-17-41.png
A parte superior apresentará o nome da empresa posicionada, além dos totalizadores de cada um dos possíveis status.
Na parte inferior estarão relacionados todos os processos disponíveis e seus respectivos status na empresa posicionada.

Guia Processo vs Empresas

A visão disponibilizada nesta guia baseia-se na navegação realizada entre os processos disponíveis na relação de processos.

Esta guia somente estará visível caso exista mais de uma empresa/grupo de empresas disponível no ambiente.

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-7-12_15-19-27.png
A parte superior apresentará o nome do processo posicionado, além dos totalizadores de cada um dos possíveis status.
Na parte inferior estarão relacionadas todas as empresas disponíveis e seus respectivos status perante o processo posicionado.

LEGENDA

Indica que o processo está atualizado.

Indica que o processo está desatualizado.

Indica que não foi possível avaliar o status do processo.

Indica que o processo não está instalado.

Indica que o processo e a rotina AdvPL possuem assinaturas incompatíveis.

Visualizando detalhes

Ao efetuar um duplo clique no grid, onde estão relacionados os processos e empresas e seus respectivos status, será exibida uma interface contendo detalhes sobre o item selecionado.
Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_14-58-57.png

As seções apresentadas são:

Seção Detalhes:
Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_15-0-52.png
Apresenta informações detalhadas sobre o ambiente:

Status da integração com a Central de Atualizações;
Código da empresa;
Nome da empresa;
Código do processo;
Nome do processo;
Release da Central de Atualizações do ambiente;

Seção Processo:
Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_15-2-14.png
Apresenta informações detalhadas do processo:

Status do processo;
Assinatura do processo instalado (em destaque para facilitar a visualização);
No campo Instalado: apresentará o ID, Data e hora do pacote ZSPS e sua assinatura;
No campo RPO: apresentará o ID, data e hora do pacote ZSPS contido no RPO e sua assinatura;
No campo TPH: apresentará o ID, data e hora do pacote ZSPS disponível na Central de Atualizações e sua assinatura.

Seção Rotina:
Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_15-3-20.png

Apresenta informações detalhadas do rotina AdvPL associada ao processo:

Status;
Assinatura da rotina AdvPL;
Nome da rotina/programa fonte;
Data e hora da rotina contida no RPO;
Data e hora da rotina disponível na Central de Atualizações;
Botão Buscar atualização: direciona para o portal de atualização, para obtenção do patch contendo a rotina em questão. Botão disponível apenas se houver integração com a Central de Atualizações.

Seção Gestão de Procedures:
Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_15-3-43.png
Apresenta informações detalhadas da interface de Gestão de Procedures (CFGX051M):

Status;
Assinatura da rotina AdvPL de gestão de procedures;
Nome da rotina/programa fonte;
Data e hora da rotina contida no RPO;
Data e hora da rotina disponível na Central de Atualizações;
Botão Buscar atualização: direciona para o portal de atualização, para obtenção do patch contendo a rotina em questão. Botão disponível apenas se houver integração com a Central de Atualizações.

Instalando pacotes de procedures

Não será necessário obter nenhum arquivo adicional para realizar a instalação dos processos. Os arquivos necessários para a instalação estarão presentes de forma embarcada no RPO. Estes arquivos possuem a extensão ZSPS e contém todas as informações necessárias para que o procedimento seja realizado de maneira off-line (sem integração com a Central de Atualizações).
Durante o procedimento de instalação, caso a integração com a Central de Atualizações esteja ativa, os processos mais atuais homologados pela TOTVS serão obtidos de maneira online e serão utilizados na instalação (desde que sejam mais recentes que os disponíveis no RPO).
Dessa forma garantimos que o ambiente esteja sempre atualizado com os processos de procedures mais recentemente homologados.

Para realizar a instalação:

Selecionar em quais empresas os processos serão instalados:

Selecionar quais processos serão instalados:

Após selecionar as empresas e processos, basta clicar no botão Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > worddav4fff3b945bb21f990a9906fa19377a01.png (instalar processos).

Será exibida uma janela com alguns avisos solicitando a confirmação da instalação:

O procedimento de instalação somente poderá ocorrer se os processos selecionados não estiverem em uso por outra rotina neste momento.
Ao confirmar, surgirá uma outra janela exibindo o andamento da instalação:
Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > worddav178d711de5a613775647d6c2fe253bb3.png

Ao final do procedimento surgirá uma janela contendo o Resumo das operações realizadas durante a instalação:

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_14-56-22.png

Nesta interface constam as seguintes informações:

- Total de operações: Quantidade total de ações a serem realizadas, baseadas nas Empresas/Grupo de Empresas e processos selecionados para instalação;
- Sucessos: Quantidade de ações realizadas com sucesso;
- Ignoradas: Quantidade de ações não realizadas/ignoradas;
- Falhas: Quantidade de ações com falhas/problemas durante sua execução;

Ainda na janela de Resumo, ao clicar no botão Ver detalhes o detalhamento das ações será exibido:

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_14-44-1.png

No botão Outras Ações é possível gerar o relatório deste log.

Ao fechar a janela de Resumo (ou de log), a interface principal será atualizada para refletir o status atual:
Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_14-45-6.png

Desinstalando pacotes de procedures

O procedimento para desinstalação de pacotes é semelhante ao de instalação. É necessário apenas que os processos envolvidos não estejam em uso. Este procedimento necessita de acesso exclusivo em algumas tabelas do banco de dados e por isso não pode haver concorrência.

Para realizar a desinstalação:

Selecionar em quais empresas os processos serão desinstalados:

Selecionar quais processos serão desinstalados:

Após selecionar as empresas e processos, basta clicar no botão Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > worddavde157571e60718492642fc5ecfcdb29d.png (desinstalar processos).
Será exibida uma janela com alguns avisos solicitando a confirmação da desinstalação:

O procedimento de desinstalação somente poderá ocorrer se os processos selecionados não estiverem em uso por outra rotina neste momento.
Ao confirmar, surgirá uma outra janela exibindo o andamento da desinstalação:
Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > worddav0379bc81e46f652071c361ea714b8ecb.png

Ao final do procedimento surgirá uma janela contendo o Resumo das operações realizadas durante a desinstalação:

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_14-49-56.png

Nesta interface constam as seguintes informações:

- Total de operações: Quantidade total de ações a serem realizadas, baseadas nas Empresas/Grupo de Empresas e processos selecionados para desinstalação;
- Sucessos: Quantidade de ações realizadas com sucesso;
- Ignoradas: Quantidade de ações não realizadas/ignoradas;
- Falhas: Quantidade de ações com falhas/problemas durante sua execução;

Ainda na janela de Resumo, ao clicar no botão Ver detalhes o detalhamento das ações será exibido:

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_14-52-14.png

No botão Outras Ações é possível gerar o relatório deste log.

Ao fechar a janela de Resumo (ou de log), a interface principal será atualizada para refletir o status atual:
Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_14-53-2.png

Consultando o histórico de operações

Para visualizar o histórico das operações realizadas, basta clicar no botão Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > worddav6d7d2d3a02b95ab972ad82169732d848.png (Histórico de operações) da interface principal:

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_15-12-55.png

As informações na parte superior desta interface se referem às ações de instalação e desinstalação realizadas, contendo entre elas:

ID da ação (sequencial e de uso interno apenas);
Data e hora de execução;
Tipo da ação (instalação ou desinstalação);
Modo: on-line ou off-line (integração com a Central de Atualizações ativa ou não);
Código e nome do usuário que executou a ação;
Dados do ambiente: nome, alias, tipo de banco, IP e porta de comunicação com DBAccess;
Totalizadores: empresas selecionadas, processos selecionados, execuções a realizar, sucessos, falhas e ignoradas;

Na parte inferior são apresentados os detalhes de cada tarefa:

ID da tarefa (sequencial e de uso interno apenas);
Tipo: Pode conter um dos seguintes valores [INFO], [OK], [SKIP], [ERRO];
Log: descritivo da tarefa realizada;
Detalhes: armazenará os detalhes dos problemas encontrados durante a execução da tarefa;

A legenda da grid inferior apresentará:

INFO - Informações genéricas;

OK - Ação realizada com sucesso;

SKIP - Ação ignorada;

ERRO - Ação com falha/problema na execução;

Ao encontrar uma ação com o tipo ERRO note que haverá o texto "Duplo clique em Memo para detalhes" na descrição do log. Nesta situação, basta efetuar um duplo clique na coluna Detalhes para visualizar a mensagem completa com a falha/problema ocorrido:

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_15-22-5.png

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_15-23-12.png

Relatório de Log

No botão Outras Ações da janela de Log é possível gerar um relatório completo de todas as operações contidas no log. Também é possível efetuar filtros e personalizar o relatório.

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-15_9-45-53.png

Ao selecionar a opção Relatório, a seguinte interface é exibida. Nesta janela é possível definir, entre outras opções, o tipo de arquivo gerado:

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-15_9-52-13.png

No exemplo acima foi selecionada a opção Planilha:

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-15_9-53-56.png

Utilize a opção Planilha para gerar um arquivo em formato Excel. Dessa forma é possível enviar o log para equipes de suporte TOTVS.

Configurações adicionais da rotina

O botão (Configurações adicionais da rotina) agora está disponível na interface principal.

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_15-34-8.png

Ele possibilita configurar o comportamento da rotina com as seguintes opções:

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_15-35-27.png

Forçar reinstalação de pacotes atualizados: Com esta opção marcada, mesmo o pacote com status Atualizado será novamente instalado no ambiente. Isso implica na realização das seguintes ações:
- Remoção das stored procedures atualmente instaladas;
- Instalação das stored procedures na base de dados a partir do pacote ZSPS utilizado para a instalação;
- Atualização das informações de controle na base de dados;

Forçar utilização de pacotes .ZSPS contidos no RPO: Com esta opção marcada, o processo de instalação utilizará o pacote ZSPS embarcado no RPO, mesmo que este não seja o mais recente disponível. Esta opção permite, por exemplo, que seja utilizado um pacote antigo que esteja presente no RPO ao invés de utilizar o pacote disponível na Central de Atualizações.

Exemplo: Processo com status Atualizado

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-15_10-56-52.png

No exemplo acima vemos que o processo está Atualizado, pois o pacote instalado possui ID 691, que é exatamente o mais recente disponibilizado.

Se marcarmos esta opção e realizarmos a instalação deste processo, veremos que o pacote com ID 7 presente no RPO será utilizado ao invés do ID 691.

Após instalar o processo com esta opção ativa, veremos nos detalhes que o pacote utilizado foi o que está contido no RPO (ID 7):

Linha Microsiga Protheus > Stored Procedures - Novo gerenciador de pacotes > image2022-9-14_15-50-38.png

Com a opção Forçar utilização de pacotes .ZSPS contidos no RPO ativa durante a instalação, é possível que o status do processo fique Desatualizado ou Incompatível. Atente-se para esta situação antes de utilizar esta opção.

Ao encerrar a interface de Gestão de Procedures, estas opções ficam desativadas. Elas devem ser reconfiguradas sempre que necessário.