- Criado por Ricardo Ferro em set 10, 2021
Descrição Geral
Este documento tem o intuito de orientar a utilização da ferramenta Gera Install. Ela tem a função de gerar Scripts de release candidate de customização de Banco de Dados.
Para que os Scripts gerados sejam utilizados no cliente deve-se entrar em contato com o setor de Gerencia de Configuração
Antes de Começar
Para que o processo seja concluído com sucesso, atente para as seguintes orientações:
Faça o download do arquivo necessários disponibilizados ao fim deste documento. (Vide seção Anexos)
Esse processo deve ser feito por usuário com perfil de Administrador.
É sugerido que o processo realizado nesse manual seja efetuado no diretório Drive (C:).
Hoje a ferramenta só atende ao produto StoreEX.
Ajustando Constantes de Localização dos Scripts Customizados
Descompacte a pasta contendo a ferramenta no diretório desejado, assim como é mostrado na imagem exemplo abaixo.
Ajuste as constantes de localização da ferramenta no arquivo CSIGeraInstallBD.ini.
Esse arquivo tem como função parametrizar a ferramenta Gera_Install, nesse arquivo deve ser informado a localização do arquivo config_p2k.ini, a localização dos "Scripts Customizados", qual diretório os "Scripts Finais" serão gerados, qual o titulo do "Repositório" e qual produto essa ferramenta atende.Declaração do bloco [Geral] gerencia os próximos blocos criados. (Por padrão não deve ser alterado)
Constante Repositório: Essa constante define qual o titulo do "Projeto de Customização"
REPOSITORIO=BD-CSTM_CLIENTE1-01.0.0-RC1,
Imagem acima é meramente ilustrativa é necessário entrar em contato com o setor de Gerencia de configuração eles disponibilizarão o padrão a ser preenchido nessa constante.
Caso seja necessário a criação de diversos projetos, acrescente uma virgula (,) logo após o titulo anterior e acrescente o titulo do novo "Projeto de Customização" como mostra no exemplo abaixo.
REPOSITORIO=BD-CSTM_CLIENTE1-01.0.0-RC1, REPOSITORIO=BD-CSTM_CLIENTE2-02.0.0-RC1,
Declaração do bloco com o [Titulo do Projeto]: Define qual o "Projeto de Customização" as próximas constantes devem referenciar, esse parâmetro esta ligado á constante Repositório.
Caso seja necessário a criação de projetos diferentes deve ser criado um novo bloco [Titulo do Projeto] com o mesmo titulo inserido na constante Repositório como mostra no exemplo abaixo.
[BD-CSTM_CLIENTE1-01.0.0-RC1] ArqConfigIni=C:\Ferramenta_GERA_INSTAL+StorEx_Custom\Cliente1\ini\config_p2k.ini PathOrigem=C:\Ferramenta_GERA_INSTAL+StorEx_Custom\Cliente1\scripts PathDestino=C:\scripts Sistema=P2K [BD-CSTM_CLIENTE-02.0.0-RC1] ArqConfigIni=C:\Ferramenta_GERA_INSTAL+StorEx_Custom\Cliente2\ini\config_p2k.ini PathOrigem=C:\Ferramenta_GERA_INSTAL+StorEx_Custom\Cliente2\scripts PathDestino=C:\scripts Sistema=P2K
Constante ArqConfigIni: Essa constante define qual a localização do arquivo config_p2k.ini, esse arquivo tem como função definir quais "Scripts Customizados" serão compilados para se tornar "Scripts Finais".
É recomendado que essa constante seja preenchida como mostra o exemplo abaixo.
ArqConfigIni=C:\Ferramenta_GERA_INSTAL+StorEx_Custom\Cliente1\ini\config_p2k.ini
Constante PathOrigem: Essa constante define qual a localização do diretório onde estão localizados os "Scripts Customizados".
É sugerido que seja preenchido como mostra o exemplo abaixo.
PathOrigem=C:\Ferramenta_GERA_INSTAL+StorEx_Custom\Cliente1\scripts
Constante PathDestino: Essa constante define qual o diretório destino dos "Scripts Finais" após a compilação dos "Scripts Customizados".
É recomendado que seja preenchido como mostra o exemplo abaixo.
PathOrigem=C:\Ferramenta_GERA_INSTAL+StorEx_Custom\Cliente1\scripts
Por padrão, após a execução dos "Scripts Finais" no Banco de Dados os logs serão gerados no diretório "c:\scripts".
Constante PreReq: Essa constante define qual outra "Versão de Atualização" é pré-requisito para que os "Scripts Finais" que estão sendo gerados possam ser executados. (opcional)
Caso a constante PreReq seja utilizada, entre em contato com ao setor de Gerencia de Configuração para verificação da existência da versão solicitada
Constante Sistema: Essa constante define para qual produto os "Scripts Finais" estão sendo gerados. (Por padrão essa constante não deve ser alterada deve estar preenchida com "=P2K")
Ajustando Constantes de Compilação
Ajuste as constantes de configuração para compilação dos "Scripts Customizados"no arquivo config_p2k.ini .
Esse arquivo tem como função definir quais "Scripts Customizados" vão ser compilados e se tornarão "Scripts Finais".É sugerido que esse arquivo esteja no diretório com o nome "ini", como mostra o exemplo abaixo.
No arquivo config_p2k.ini
Declaração do bloco com o [Tipo Objeto]: Define qual o "Tipo Objeto" será criado a partir dos "Scripts Customizados" no Banco de Dados são eles:
[TYPESRULESDEFAULTS]
[TABELAS]
[TABELAS2]
[SEQUENCES]
[SEQUENCES]
[VIEWS]
[FUNCTIONS]
[PROCEDURES]
[PROCEDURES_SQL_2005]
[PACKAGES]
[PACKAGES_SQL_2005]
[TRIGGERS]
[GRANTS]
[SINONIMOS]
[DADOS]
[EVOLUCAO2]
[JOBS]
[TEMPLATES]
[OPCOES_MENU]
[OPCOES_MENU_SAFE]
[TEMPLATES_SAFE]
Cada bloco listado acima por padrão tem duas constantes: ORDEM e NUMFILES
Constante ORDEM: Essa constante define qual a ordem de compilação da ferramenta Gera_Install para cada bloco [Tipo Objeto] como mostra o exemplo abaixo. (Por padrão essas constantes não devem ser alteradas)
[TYPESRULESDEFAULTS] ORDEM=1 NUMFILES=0 [TABELAS] ORDEM=2 NUMFILES=0 [TABELAS2] ORDEM=3 NUMFILES=0 [SEQUENCES] ORDEM=4 NUMFILES=0 [EVOLUCAO] ORDEM=5 NUMFILES=0 [VIEWS] ORDEM=6 NUMFILES=0 [FUNCTIONS] ORDEM=7 NUMFILES=0
Constante NUMFILES: Essa constante define quantos "Scripts Customizados" a ferramenta deve compilar.
Constante FILE: Essa constante define qual sequencia de compilação dos "Script Customizado" e quais "Scripts Customizados" a ferramenta deve compilar para cada bloco [Tipo Objeto].
As constantes NUMFILES de cada bloco [Tipo Objeto] influenciam diretamente na constante FILE.
Para cada arquivo de "Script Customizado" que será compilado deve existir uma constante FILE com a numeração da ordem de compilação como mostra no exemplo abaixo.
[TYPESRULESDEFAULTS] ORDEM=1 NUMFILES=3 FILE1=P2K_P2K_UTIL FILE2=SET_CURRENT_SCHEMA FILE3=TypesRulesDefaults
Conteúdo das Pastas Com os "TIPOS OBJETOS" a Serem Criados
Em cada pasta existem arquivos de "Scripts Customizados" onde contém quais "Objetos" serão criados no Banco de Dados. Devem existir dois arquivos de "Scripts Customizados" com o mesmo nome, mas com extensões diferentes, um com a extensão .sql (para a Base de Dados SQLServer) e outra com .ora (para a Base de Dados Oracle).
Exemplo: Dados_CSTM_HUB_PRODUTO.sql
Dados_CSTM_HUB_PRODUTO.ora
A Ferramenta necessita que esses dois arquivos estejam no diretório referenciado no parâmetro "PathOrigem
", caso contrário a ferramenta exibirá uma mensagem de erro.
O Produto Storex, por Padrão, não trabalha mais com SQLServer, porém para evitar os erros de warning apresentados acima, é recomendado que existam ambos os arquivos com suas respectivas extensões, mesmo que o arquivo .SQL não contenha nenhuma informação (criando o arquivo vazio) .
Gerando os Scripts Finais
- Execute como ADMINISTRADOR o arquivo CSIGeraInstallBD.exe,
- Clique em SIM na tela de Controle de Conta de Usuário.
- Selecione o Repositório.
- Selecione qual o "Tipo do Objeto" vai ser compilado em "Scripts Finais" (você tem a liberdade de criar todos os "Scripts Finais" ou separadamente).
- Clique no Botão Gera Install os "Scripts Finais" estarão no diretório designado pela Constante "PathDestino".
Anexos
Anexo | Descrição |
---|---|
Ferramenta Gera_Install e Storex Custom para Download |