Sumário
Novo Gestor de Stored Procedures – CFGX051CFGX051M
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
Entendendo os status dos processos e ações que podem ser tomadas
Instalando/Atualizando pacotes de procedures
Desinstalando pacotes de procedures
Consultando o histórico de operações
Relatório de Log
Resolução de problemas pontuais sem necessidade de contato com suporte TOTVS
Configurações adicionais da rotina

Novo Gestor de Stored Procedures –

...

CFGX051M

O programa Gerenciador de procedures (antigo CFGX051.PRW, atual CFGX051M.PRW), 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 dentro do no RPO. A atualização destes arquivos ocorrerá de maneira semelhante à atualização de qualquer artefato dentro do RPO, 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.

Âncora
migracao_novo_modelo migracao_novo_modelo _heading h.30j0zll

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 o patch a última release da Central de Atualizações Release 1. 4.1 (ou superior). Para isso acesse a página de Release Notes e baixe o patch mais recente disponibilizado.

Image Removed

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

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

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

Passo 3: Acesse o programa Gerenciador de procedures (CFGX051), através do menu Base de Dados | Dicionário | Stored Procedure. Será apresentada a seguinte interface:
Image Removed

...

...

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.

...

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.
Image Removed

...

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

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

...

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

...

Image Removed
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.

...

As seções apresentadas são:
Seção Detalhes:
Image Removed
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.

...

• Status;
• Código da assinatura;
• ID e data do pacote ZSPS instalado;
• ID e data do pacote ZSPS contido no RPO;
• ID e data do pacote ZSPS disponível na Central de Atualizações.

Seção Rotina:
Image Removed

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

• Status;
• Código da assinatura;
• Nome da rotina/programa fonte;
• Data da rotina contida no RPO;
• Data 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 (estará disponível apenas se houver integração com a Central de Atualizações).

...

• Status;
• Código da assinatura;
• Nome da rotina/programa fonte;
• Data da rotina contida no RPO;
• Data 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 (estará disponível apenas se houver integração com a Central de Atualizações).

...

Versão 12.1.2210

1. FAT (Faturamento) - https://suporte.totvs.com/portal/p/10098/download?e=1080341
2. COM (Compras) - https://suporte.totvs.com/portal/p/10098/download?e=1080335
3. FIS (Fiscal) - https://suporte.totvs.com/portal/p/10098/download?e=1080345
4. FIN (Financeiro) - https://suporte.totvs.com/portal/p/10098/download?e=1080343
5. EST (Estoque) - https://suporte.totvs.com/portal/p/10098/download?e=1080339
6. CTB (Controladoria) - https://suporte.totvs.com/portal/p/10098/download?e=1080337

Versão 12.1.2310

1. FAT (Faturamento) - https://suporte.totvs.com/portal/p/10098/download?e=1123877
2. COM (Compras) - https://suporte.totvs.com/portal/p/10098/download?e=1123869
3. FIS (Fiscal) - https://suporte.totvs.com/portal/p/10098/download?e=1123881
4. FIN (Financeiro) - https://suporte.totvs.com/portal/p/10098/download?e=1123879
5. EST (Estoque) - https://suporte.totvs.com/portal/p/10098/download?e=1123875
6. CTB (Controladoria) - https://suporte.totvs.com/portal/p/10098/download?e=1123873
7. ATF (Ativo Fixo) - https://suporte.totvs.com/portal/p/10098/download?e=1123865
8. PCO (Planejamento e Controle Orçamentário) - https://suporte.totvs.com/portal/p/10098/download?e=1123883

Passo 3: Acesse o programa Gerenciador de procedures, através do menu Base de Dados | Dicionário | Stored Procedure. Será apresentada a seguinte interface:
Image Added

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.

Âncora
nova_interface nova_interface _heading h.1fob9te

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 permitem o gerenciamento dos processos de maneira prática e rápida, realizando a instalação e remoção com poucos cliques. Consulta e relatório de log de processamento e configurações adicionais também estão disponíveis. Novas abas permitem uma navegação mais simples e eficiente para visualizar os processos e empresas. Os totalizadores fornecem, de forma rápida, um resumo dos status dos processos.

Image Added

Entendendo as informações exibidas no título da interface:

Image Added

Image Added - Título da interface. A rotina Gestão de Procedures (programa CFGX051M.PRW) também é chamada de instalador de pacotes de procedures.

Image Added - É a data e hora do programa CFGX051M.PRW compilado no RPO em uso. Este valor será atualizado sempre que uma nova versão do programa for aplicada no RPO através de patchs de atualização.

Image Added - É a assinatura da rotina de Gestão de Procedures. Esta assinatura é utilizada para garantir que a versão do instalador seja compatível com os pacotes ZSPS utilizados para instalação de processos. Esta assinatura será atualizada (incrementada) conforme a evolução da rotina de instalação. Se o instalador não possuir a assinatura mínima exigida pelo pacote ZSPS, durante a instalação será armazenado no log de operações uma mensagem informando a existência de um problema de incompatibilidade entre o pacote ZSPS e o instalador. Nestes casos será necessário atualizar o instalador seguindo as orientações contidas no próprio log. Para mais detalhes sobre o log de operações, veja os itens Instalando/Atualizando pacotes de procedures e Consultando o histórico de operações.

Image Added - É a release da Central de Atualizações atualmente encontrada no ambiente em uso. Essa informação não determina que a Central de Atualizações está configurada no ambiente, ela apenas mostra a versão dos programas de Gestão de Procedures que por sua vez estão diretamente ligados à Central de Atualizações. Para mais informações sobre a Central de Atualizações clique aqui.

Image Added - A sigla TPH refere-se à Central de Atualizações. Pode apresentar dois valores: TPH: ON quando há conectividade, ou TPH: OFF quando não há conectividade com a Central de Atualizações. Neste caso a ausência pode ser temporária, ou seja, algum problema ocorreu durante a inicialização da interface, ou definitiva quando não há realmente nenhuma configuração no ambiente que possibilite o uso da Central de Atualizações. 

Âncora
relacao_empresas relacao_empresas _heading h.3znysh7

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.

Image Added

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

• Image Added Instalar os pacotes selecionados nas empresas selecionadas.
• Image Added Remover os pacotes selecionados das empresas selecionadas.
• Image Added Marcar todas as empresas disponíveis no grid.
• Image Added Desmarcar todas as empresas do grid.
• Image Added Consultar o histórico de operações.
• Image Added Configurações adicionais da rotina.
• Image Added Link para a documentação oficial da rotina (esta página).

Âncora
relacao_processos relacao_processos _heading h.2et92p0

Relação de processos

Serão listados todos os processos disponíveis para instalação.
Image Added

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

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

Âncora
guia_empresa_processos guia_empresa_processos _heading h.tyjcwt

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.

Image Added
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.

Âncora
guia_processo_empresas guia_processo_empresas _heading h.3dy6vkm

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.

Image Added
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

Image Added Indica que o processo está atualizado.

Image Added Indica que o processo está desatualizado.

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

Image Added Indica que o processo não está instalado.

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

O detalhamento dos status está no tópico Entendendo os status dos processos e ações que podem ser tomadas.

Âncora
visualizando_detalhes visualizando_detalhes _heading h.23k0u7fdxslw

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.
Image Added

As seções apresentadas são:

Seção Detalhes:
Image Added
Apresenta informações detalhadas sobre o ambiente:

• Status da integração com a Central de Atualizações(sigla TPH):
  • ON (modo online) quando conectividade está ativa ou
  • OFF (modo offline) quando não há conectividade;
• 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:
Image Added
Apresenta informações detalhadas do processo:

• Status do processo: os possíveis status estão detalhados em Entendendo os status dos processos e ações que podem ser tomadas.
• Assinatura do processo instalado (em destaque para facilitar a visualização): exemplo na imagem 003
• No campo Instalado:
  • IDSPS (identificador único do pacote): exemplo na imagem (-17)
  • Data e hora do pacote ZSPS instalado: exemplo na imagem 21/01/2020 14:24:14 
  • Assinatura do pacote ZSPS instalado: exemplo na imagem [003]
• No campo RPO:
  • IDSPS (identificador único do pacote): exemplo na imagem (998)
  • Data e hora do pacote ZSPS contido no RPO : exemplo na imagem: 20/03/2023 08:09:32
  • Assinatura do pacote ZSPS contido no RPO: exemplo na imagem: [003]
• No campo TPH:
  • IDSPS (identificador único do pacote): exemplo na imagem (1171)
  • Data e hora do pacote ZSPS disponível na Central de Atualizações : exemplo na imagem: 03/05/2023 18:20:42
  • Assinatura do pacote ZSPS disponível na Central de Atualizações: exemplo na imagem: [004]

Seção Rotina:
Image Added

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

• Status da rotina compilada no RPO:
  • Atualizado: a rotina está na sua versão mais recente disponibilizada pela TOTVS.
  • Desatualizado: significa que a rotina AdvPL compilada no RPO não é a mais recente disponibilizada pela TOTVS. Existe(m) patch(s) de atualização (.PTM) com uma versão mais recente disponível.

           Obs.: A comparação é realizada com a Central de Atualizações. Em ambientes offline essa comparação não é possível, ou seja, o status da rotina será sempre Não avaliado.

• Assinatura da rotina AdvPL: é utilizada para garantir a compatibilidade entre a rotina AdvPL e o processo (Stored Procedure);
• 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 (exibido somente se o ambiente estiver online);
• 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 (modo online).

Seção Gestão de Procedures:
Image Added
Apresenta informações detalhadas da interface de Gestão de Procedures (CFGX051M):

• Status da rotina compilada no RPO:
  • Atualizado: a rotina está na sua versão mais recente disponibilizada pela TOTVS.
  • Desatualizado: significa que a rotina AdvPL compilada no RPO não é a mais recente disponibilizada pela TOTVS. Existe(m) patch(s) de atualização (.PTM) com uma versão mais recente disponível.

           Obs.: A comparação é realizada com a Central de Atualizações. Em ambientes offline essa comparação não é possível, ou seja, o status da rotina será sempre Não avaliado.

• Assinatura da rotina AdvPL de gestão de procedures: é usada para garantir a compatibilidade entre a rotina de gestão de procedures (instalador) e os pacotes 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 (modo online).

Âncora
entendendo_os_status entendendo_os_status _heading h.f41wful3yjzh

Entendendo os status dos processos e ações que podem ser realizadas

A nova interface exibe uma série de ícones para representar os status possíveis para os processos. Aqui estão relacionados os possíveis status e as ações que podem ser tomadas para cada situação.

Image Added ATUALIZADO: O processo instalado no ambiente está atualizado com a última versão disponível em comparação ao pacote que está no RPO (modo offline) ou em relação ao pacote disponível na Central de Atualizações (modo online).

Solução:

Nenhuma ação é necessária neste caso.

Image Added DESATUALIZADO: O processo instalado no ambiente não está na sua versão mais recente disponibilizada pela TOTVS. Isso significa apenas que o IDSPS do pacote instalado é inferior ao IDSPS do último pacote homologado. Um pacote que está desatualizado não representa um erro e sua atualização não é obrigatória ou urgente. Um pacote de procedures com este status pode perfeitamente ser executado por sua rotina AdvPL.

Ao encontrarmos processos com este status, devemos considerar:

Em ambientes online: A comparação é realizada com os pacotes disponíveis na Central de Atualizações. Vamos pegar como exemplo um processo desatualizado onde o IDSPS instalado é inferior ao IDSPS disponível na Central de Atualizações:

Exemplo de processo desatualizado:

Image Added

Visualizando os detalhes do processo:

Image Added

Note que o IDSPS do processo instalado (7) é inferior ao IDSPS do processo mais recente disponível na Central de Atualizações (691). Por este motivo o status do processo fica Desatualizado. Isto ocorre pois o processo recém homologado fica disponível para uso imediatamente à sua publicação e a ferramenta faz a leitura em tempo real, sem que nenhum patch seja aplicado no ambiente.

Em ambientes offline: A comparação é realizada com os pacotes embarcados no RPO. Vamos pegar como exemplo um processo desatualizado onde o IDSPS instalado é inferior ao IDSPS disponível no RPO:

Image Added

Visualizando os detalhes do processo:

Image Added

Isso pode ocorrer após a aplicação de algum patch (.PTM) contendo o pacote ZSPS mais atual. Nesta situação, como o IDSPS do processo instalado (13) é inferior ao IDSPS do processo disponível no RPO (647), o status do processo é Desatualizado.

Solução: ATUALIZAR O PROCESSO

Para atualizar o processo basta realizar o procedimento descrito no tópico a seguir Instalando/Atualizando pacotes de procedures.

Não será necessário obter nenhum arquivo adicional, nem realizar a aplicação de patchs de atualizações (.PTM). A própria rotina de Gestão de Procedures se encarregará de obter o pacote mais recente disponível (da Central de Atualizações para ambientes online ou do próprio RPO para ambientes offline) e realizará a instalação no ambiente. O status do processo após a instalação será alterado para Atualizado. 

Caso o processo esteja funcionando corretamente em seu ambiente, não há motivos para atualizá-lo com urgência. Avalie também a atualização da rotina AdvPL associada ao processo. Programe o melhor momento para realizar esta atualização já que, caso seja necessária, a atualização da rotina deve ser efetuada primeiro por meio do patch indicado e somente então o processo poderá ser atualizado.

Image Added NÃO AVALIADO: Neste caso o processo instalado no ambiente não pôde ser comparado com o que está embarcado no RPO (modo offline) nem com o que está disponível na Central de Atualizações (modo online). Este status é muito peculiar e não ocorrerá com frequência, exceto nas seguintes situações:

• Caso a conectividade entre a aplicação e a Central de Atualizações seja interrompida ou inexistente no ambiente durante a análise realizada pela ferramenta e
• Quando não existe nenhum arquivo de pacote de procedures embarcado no RPO (arquivos .ZSPS)

Peguemos como exemplo um processo nesta situação:

Image Added

Ao analisarmos os detalhes do processo, veremos:

Image Added

No exemplo acima, constatamos que não há informações sobre o pacote no RPO. Isso significa que não existe o arquivo ZSPS do processo em questão de forma embarcada. Isso pode acontecer, por exemplo, se:

• • Não foi aplicado nenhum patch (.PTM) contendo os pacotes de procedures (recomendamos a leitura do tópico Migração para o novo modelo);
  • O arquivo ZSPS foi deletado do RPO;

Também constatamos que não há informações sobre o pacote na Central de Atualizações. O campo TPH (referente à Central de Atualizações) nem ao menos foi exibido na janela de detalhes. Isso significa que no momento em que a rotina foi executada a conectividade entre a aplicação e a Central de Atualizações foi interrompida ou é inexistente no ambiente em questão. Por estes motivos o status do processo será Não avaliado. 

Solução:

A solução neste caso envolve:

• • Checagem da conectividade entre a aplicação e a Central de Atualizações;
  • Aplicação de patch (.PTM) contendo o pacote ZSPS do processo em questão;

Após certificar de que o ambiente está normalizado, a reabertura da interface se faz necessária para que o status do processo seja novamente analisado. Não é necessário realizar a instalação/atualização do processo. 

Image Added NÃO INSTALADO: Um processo não instalado não representa uma anormalidade ou um erro. A instalação ou não do processo deve seguir as necessidades de cada ambiente onde a responsabilidade é dividida entre o administrador do sistema e as equipes que farão uso daquele processo. As rotinas Protheus associadas aos processos (ver o tópico Visualizando detalhes) funcionam normalmente sem que os processos estejam instalados no ambiente, porém o desempenho delas não é o mesmo se comparado ao desempenho das stored procedures.

Solução:

Caso seja necessário instalar um processo, basta seguir o procedimento descrito no tópico a seguir Instalando/Atualizando pacotes de procedures.

Image Added INCOMPATÍVEL: Nesta situação as assinaturas do processo e da rotina AdvPL (consulte tópico Visualizando detalhes) são incompatíveis. Isso significa que a rotina AdvPL que faz a chamada para as procedures não poderá utilizá-las. Ao tentar executar uma rotina que esteja incompatível com seu processo de stored procedures, o usuário receberá a seguinte mensagem:

Exemplo de mensagem de incompatibilidade entre a rotina AdvPL e o processo:

Image Added

No exemplo acima vemos que a rotina FINA410 tentou executar a stored procedure FIN003_09 e recebeu um erro. Isso ocorre porque a assinatura da rotina (013) não é a mesma assinatura da stored procedure (011). A rotina não poderá ser executada utilizando as stored procedures até que as assinaturas sejam compatibilizadas.

Podemos verificar estas informações ao visualizarmos os detalhes do processo (no caso é o processo 09).

Image Added

Constatamos então que as assinaturas são diferentes.

Solução: COMPATIBILIZAR AS ASSINATURAS

A solução nestes casos envolve uma das seguintes opções:

• • Se a assinatura do processo for inferior à assinatura da rotina AdvPL, então o processo deve ser atualizado. Para isso, opte pela solução adequada ao seu cenário:
    • Em ambientes online: Executar a instalação/atualização do processo em questão.
    • Em ambientes offline: Obter um patch (.PTM) que contenha a versão mais recente do processo em questão e realizar a instalação.
  • Se a assinatura da rotina AdvPL for inferior à assinatura do processo: deve-se aplicar o patch (.PTM) contendo a versão mais atualizada da rotina em questão (consulte tópico Visualizando detalhes, subitem Seção Rotina);

Se mesmo após a aplicação do patch (.PTM) mais atual da rotina e/ou instalação do processo mais atual disponibilizado pela TOTVS as assinaturas continuarem incompatíveis, o suporte deverá ser acionado para entender o ocorrido. Existe ainda a alternativa para solucionar o problema de incompatibilidade de assinaturas por meio da opção Forçar utilização de pacotes .ZSPS contidos no RPO. Entretanto deve-se analisar os detalhes do processo (consulte tópico Visualizando detalhes, subitem Processo) e identificar se as assinaturas da rotina e do processo embarcado no RPO são compatíveis. Veja os detalhes do funcionamento desta opção em Configurações adicionais da rotina.

Image Added EMERGENCIAL: Processos com este status referem-se à situações onde foi aplicado um patch de correção (.PTM) contendo um pacote ZSPS Emergencial para correção de problemas pontuais em stored procedures. Clientes que utilizam o serviço PRIME recebem estes patchs (.PTM) com urgência. Pacotes ZSPS podem ser gerados com essa característica (Emergencial) e só são enviados aos clientes em situações específicas. Estes pacotes não são homologados pelo procedimento padrão TOTVS e sua função é a de sanar problemas pontuais ocorridos no ambiente de clientes PRIME.

A ferramenta quando encontra pacotes ZSPS do tipo Emergencial embarcados no RPO passa a se comportar de maneira distinta. No momento da instalação/atualização de processos, ao encontrar no RPO um pacote ZSPS Emergencial, a rotina fará uso dele em detrimento de pacotes encontrados na Central de Atualizações (desde que sejam mais recentes que os homologados e disponíveis na Central de Atualizações).

A interface passa a realizar uma série de controles específicos para garantir, por exemplo, que um pacote Emergencial não seja substituído por um outro pacote cujo conteúdo ainda não tenha sofrido as mesmas correções efetuadas no pacote recebido em caráter emergencial. Dessa forma garantimos que o ambiente não perca as correções contidas no pacote Emergencial, fundamentais para o correto funcionamento das rotinas.

Solução: AGUARDAR EXPEDIÇÃO OFICIAL CONTENDO CORREÇÕES EMERGENCIAIS

Quando a TOTVS concluir as correções em carater oficial e realizar a expedição de um novo pacote ZSPS do processo envolvido, este ficará disponível na Central de Atualizações e também no patch de correção (.PTM) gerado pela expedição realizada. A partir deste momento o processo poderá ser atualizado pela ferramenta, seja de maneira online ou offline.

Ao homologar um novo pacote ZSPS contendo todas as correções feitas no pacote ZSPS Emergencial, garantimos que as correções emergenciais estão presentes de forma oficial nos processos disponibilizados. Assim ao efetuar a atualização do processo Emergencial, a ferramenta identifica que o pacote mais recente homologado pode ser usado para substituir o pacote Emergencial do ambiente. Quando isso ocorre, o status do processo passa a ser Atualizado.

Image Added PILOTO: Processos com este status referem-se à processos que estão em testes por clientes Piloto. Somente com o consentimento e acordo entre Cliente e TOTVS é que um patch de atualização (.PTM) contendo um arquivo ZSPS Piloto é enviado ao cliente. Clientes considerados Pilotos estão em acordo com a TOTVS para realizarem testes de novos processos de procedures e/ou novas funcionalidades em processsos já existentes. Estes pacotes não são homologados pelo procedimento padrão TOTVS e sua função é a de proporcionar ao cliente um ambiente de testes, no qual as rotinas e stored procedures envolvidas ainda estão sendo testadas.

A ferramenta quando encontra pacotes ZSPS do tipo Piloto embarcados no RPO passa a se comportar de maneira distinta. No momento da instalação/atualização de processos, ao encontrar no RPO um pacote ZSPS Piloto, a rotina fará uso dele em detrimento de pacotes encontrados na Central de Atualizações (desde que sejam mais recentes que os homologados e disponíveis na Central de Atualizações).

A interface passa a realizar uma série de controles específicos para garantir, por exemplo, que um pacote Piloto não seja substituído por um outro pacote cujo conteúdo não contenha as mesmas inovações efetuadas no pacote recebido em caráter de inovação. Dessa forma garantimos que o ambiente não perca as atualizações contidas no pacote Piloto, fundamentais para a realização dos testes das rotinas e stored procedures envolvidas.

Solução: AGUARDAR EXPEDIÇÃO OFICIAL CONTENDO AS INOVAÇÕES

Quando a TOTVS concluir, em conjunto com os Clientes Piloto, os testes das inovações em carater oficial e realizar a expedição de um novo pacote ZSPS do processo envolvido, este ficará disponível na Central de Atualizações e também no patch de atualização (.PTM) gerado pela expedição realizada. A partir deste momento o processo poderá ser atualizado pela ferramenta, seja de maneira online ou offline.

Ao homologar um novo pacote ZSPS contendo todas as inovações feitas no pacote ZSPS Piloto, garantimos que as inovações criadas estão presentes de forma oficial nos processos disponibilizados. Assim ao efetuar a atualização do processo Piloto, a ferramenta identifica que o pacote mais recente homologado pode ser usado para substituir o pacote Piloto do ambiente. Quando isso ocorre, o status do processo passa a ser Atualizado.

Âncora
instalando_pacotes instalando_pacotes _heading h.f41wful3yjzh

Instalando/Atualizando pacotes de procedures

Em ambientes offline: 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 offline (sem integração com a Central de Atualizações). Caso o processo a ser instalado não possua o referido arquivo .ZSPS embarcado no RPO (para constatar isso, consulte o tópico Visualizando detalhes), será necessário aplicar um patch (.PTM) que contenha o arquivo.

Em ambientes online: Durante o procedimento de instalação em ambientes integrados com a Central de Atualizações, os processos mais recentes homologados e disponibilizados 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 e disponibilizados pela TOTVS e/ou presentes no ambiente (de forma embarcada no RPO).

Para realizar a instalação/atualização:

• Selecionar em quais empresas os processos serão instalados/atualizados:
  Image Added

• Selecionar quais processos serão instalados/atualizados:
  Image Added

Após selecionar as empresas e processos, basta clicar no botão Image Added (instalar processos).

Será exibida uma janela com alguns avisos solicitando a confirmação:
Image Added

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:
Image Added

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

Image Added

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:

Image Added

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:
Image Added

Âncora
desinstalando_pacotes desinstalando_pacotes _heading h.4d34og8

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:
  Image Added

• Selecionar quais processos serão desinstalados:
  Image Added

Após selecionar as empresas e processos, basta clicar no botão Image Added (desinstalar processos).
Será exibida uma janela com alguns avisos solicitando a confirmação da desinstalação:
Image Added

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:
Image Added

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

Image Added

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:

Image Added

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:
Image Added

Âncora
consultando_historico consultando_historico _heading h.2s8eyo1

Consultando o histórico de operações

Para visualizar o histórico das operações realizadas, basta clicar no botão Image Added (Histórico de operações) da interface principal:

Image Added

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á:

Image Added INFO - Informações genéricas;

Image Added OK - Ação realizada com sucesso;

Image Added SKIP - Ação ignorada;

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

Ao encontrar uma ação com o tipo Image Added 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:

Image Added

Conteúdo da coluna Detalhes:
Image Added

Âncora
relatório_log relatório_log _heading h.2s8eyo1

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.

Image Added

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:

Image Added

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

Image Added

Âncora
resolução_problemas resolução_problemas _heading h.2s8eyo1

Resolução de problemas pontuais sem necessidade de contato com suporte TOTVS

Alguns problemas ocorridos durante o procedimento de instalação/desinstalação podem ser resolvidos pelo próprio cliente, sem a necessidade de abertura de chamado e/ou contato com o suporte TOTVS. Para isso, basta visualizar os detalhes do log e seguir as instruções.

Os exemplos abaixo demonstram erros ocorridos durante a instalação de processos. São apresentadas as causas dos problemas e também as soluções propostas para os casos.

Problema reportado: Incompatibilidade de assinaturas entre rotina AdvPL e processo:

Cenário 1: Rotina AdvPL com assinatura inferior

Image Added

Neste exemplo a assinatura da rotina MATA280.PRX (003) é inferior à assinatura do processo (004). Esta situação é descrita no tópico Entendendo os status dos processos e ações que podem ser tomadas.

A solução proposta para o problema é atualizar a rotina MATA280.PRX, compatibilizando as assinaturas. É indicado o link para download do patch (.PTM) mais recente disponível que contém a referida rotina. Espera-se que com a aplicação deste patch, a assinatura da rotina passe a ser idêntica à assinatura do processo (004).

Se mesmo após a aplicação do patch (.PTM) indicado as assinaturas continuarem incompatíveis, o suporte deverá ser acionado para entender o ocorrido. Existe ainda a alternativa para solucionar o problema de incompatibilidade de assinaturas por meio da opção Forçar utilização de pacotes .ZSPS contidos no RPO. Entretanto deve-se analisar os detalhes do processo (consulte tópico Visualizando detalhes, subitem Processo) e identificar se as assinaturas da rotina e do processo embarcado no RPO são compatíveis. Veja os detalhes do funcionamento desta opção em Configurações adicionais da rotina. Se isso acontecer, significa que a rotina em questão não foi devidamente compatibilizada com o processo ao qual ela está associada, e isso deverá ser informado na abertura do chamado. Dessa forma a área responsável poderá identificar o problema e providenciar a compatibilização.

Cenário 2: Processo com assinatura inferior

Image Added

Neste exemplo a assinatura do processo (010) é inferior à da rotina (011). Esta situação é descrita no tópico Entendendo os status dos processos e ações que podem ser tomadas.

A solução proposta para o problema é atualizar o processo, compatibilizando as assinaturas. É importante lembrar que se o ambiente estiver integrado à Central de Atualizações e esta não oferecer um processo com a assinatura compatível, o contato com o suporte se faz necessário. Se o ambiente for offline, então a obtenção do patch (.PTM) conforme as instruções do log deve ser realizada. 

Se mesmo após a aplicação do patch (.PTM) indicado as assinaturas continuarem incompatíveis, o suporte deverá ser acionado para entender o ocorrido. Se isso ocorrer, significa que o processo em questão não foi devidamente compatibilizado com a rotina à qual ele está associado, e isso deverá ser informado na abertura do chamado. Dessa forma a área responsável poderá identificar o problema e providenciar a compatibilização.

Problema reportado: Incompatibilidade de assinaturas entre processo e rotina CFGX051M.PRW (instalador de procedures):

Image Added

Neste exemplo o problema de incompatibilidade é entre o processo e a rotina CFGX051M.PRW (o próprio instalador).

Isso ocorre porque os arquivos ZSPS exigem uma assinatura mínima do instalador para serem utilizados. Essa assinatura garante que os pacotes ZSPS construídos para serem utilizados por uma determinada versão do instalador não gerem errorlog caso o instalador esteja desatualizado.

Esse mecanismo é necessário pois a construção das procedures segue um padrão pré-estabelecido pela TOTVS. Por estarmos sempre em evolução, o programa instalador sofre alterações para se adequar à forma como as procedures são escritas. Diante disso, precisamos garantir que uma procedure possa ser lida e processada corretamente pelo programa instalador. Por este motivo o programa instalador deve estar sempre atualizado (consulte tópico Visualizando detalhes, subitem Seção Gestão de Procedures);

Note que, assim como nos exemplos anteriores, existem neste log a causa do problema e uma solução proposta para ele. E da mesma forma, um link que, ao ser acionado nos levará para a página de downloads diretamente para o patch (.PTM) contendo a versão mais recente disponível. Após aplicado, a assinatura do instalador estará compatível com a assinatura mínima exigida. Caso isso não ocorra, então o suporte deverá ser acionado.

Em todos os casos descritos acima o mais importante é ressaltar que, mesmo sem acionar o suporte TOTVS, alguns problemas podem ser solucionados apenas seguindo as instruções contidas nos detalhes do log. Salientamos com isso a importância de sempre verificar as ocorrências do tipo Image Added ERRO no log de operações.

Âncora
configurações_adicionais configurações_adicionais _heading h.2s8eyo1

Configurações adicionais da rotina

O botão Image Added(Configurações adicionais da rotina) está disponível na interface principal, na barra lateral:

Image Added

Ao ser acionado, exibe uma interface onde é possível configurar o comportamento da rotina com as seguintes opções:

Image Added

• 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 

Image Added

No exemplo acima vemos que o processo está Atualizado, pois o pacote instalado possui IDSPS 691, que é exatamente o mais recente disponível na Central de Atualizações.

Se marcarmos esta opção e realizarmos a instalação deste processo, veremos que o pacote com IDSPS 7 presente no RPO será utilizado ao invés do IDSPS 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 (IDSPS 7):

Image Added

• Forçar utilização de pacotes .ZSPS disponíveis na Central de Atualizações: Esta opção estará disponível apenasse houver integração com a Central de Atualizações. Ela muda o comportamento padrão da rotina no que se refere à utilização de pacotes ZSPS não homologados (Piloto e/ou Emergencial) com prioridade. O comportamento padrão da rotina é o de utilizar estes tipos de pacotes com prioridade, porém caso esteja ativa, o procedimento de instalação sempre utilizará o pacote ZSPS disponível na Central de Atualizações. Caso o pacote ZSPS não possa ser obtido na Central de Atualizações, a rotina não fará uso do pacote embarcado no RPO e armazenará uma mensagem no log de processamento contendo os detalhes do ocorrido.

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

• Selecionar em quais empresas os processos serão instalados:
  Image Removed

• Selecionar quais processos serão instalados:
  Image Removed

...

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:
Image Removed

Ao final do procedimento surgirá uma janela contendo o log da operação realizada:
Image Removed

...

• Selecionar em quais empresas os processos serão desinstalados:
  Image Removed

• Selecionar quais processos serão desinstalados:
  Image Removed

Após selecionar as empresas e processos, basta clicar no botão Image Removed (desinstalar processos).
Será exibida uma janela com alguns avisos solicitando a confirmação da desinstalação:
Image Removed

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:
Image Removed

Ao final do procedimento surgirá uma janela contendo o log da operação realizada:
Image Removed

No botão Outras Ações é possível gerar o relatório deste log.
Ao fechar a janela de log, a interface principal será atualizada para refletir o status atual:
Image Removed

...

Para visualizar todas as operações realizadas, basta clicar no botão Image Removed (Histórico de operações)
Image Removed

...