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:

  1. Faça o download do arquivo necessários disponibilizados ao fim deste documento. (Vide seção Anexos)

  2. Esse processo deve ser feito por usuário com perfil de Administrador.

  3. É sugerido que o processo realizado nesse manual seja efetuado no diretório Drive (C:).

  4. Hoje a ferramenta só atende ao produto StoreEX.

Sumário

Ajustando Constantes de Localização dos Scripts Customizados


  1. Descompacte a pasta contendo a ferramenta no diretório desejado, assim como é mostrado na imagem exemplo abaixo.


  2. 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.

  3. Declaração do bloco [Geral] gerencia os próximos blocos criados. (Por padrão não deve ser alterado) 

  4. 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. 

  5. 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,
  6. Declaração do bloco com o [Titulo do Projeto]: Define qual o "Projeto de Customizaçãoas próximas constantes devem referenciar, esse parâmetro esta ligado á constante Repositório.

  7. 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
  8. 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". 

  9. É recomendado que essa constante seja preenchida como mostra o exemplo abaixo.

    ArqConfigIni=C:\Ferramenta_GERA_INSTAL+StorEx_Custom\Cliente1\ini\config_p2k.ini
  10. Constante PathOrigemEssa constante define qual a localização do diretório onde estão localizados os "Scripts Customizados".

  11. É sugerido que seja preenchido como mostra o exemplo abaixo.

    PathOrigem=C:\Ferramenta_GERA_INSTAL+StorEx_Custom\Cliente1\scripts
  12. Constante PathDestino: Essa constante define qual o diretório destino dos "Scripts Finais" após a compilação dos "Scripts Customizados".

  13. É recomendado que seja preenchido como mostra o exemplo abaixo.

    PathOrigem=C:\Ferramenta_GERA_INSTAL+StorEx_Custom\Cliente1\scripts


  14. 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".

  15. 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


  16. 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



  1. 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". 

  2. É sugerido que esse arquivo esteja no diretório com o nome "ini", como mostra o exemplo abaixo.


  3. No arquivo config_p2k.ini

  4. 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:

    1. [TYPESRULESDEFAULTS]

    2. [TABELAS]

    3. [TABELAS2]

    4. [SEQUENCES]

    5. [SEQUENCES]

    6. [VIEWS]

    7. [FUNCTIONS]

    8. [PROCEDURES]

    9. [PROCEDURES_SQL_2005]

    10. [PACKAGES]

    11. [PACKAGES_SQL_2005]

    12. [TRIGGERS]

    13. [GRANTS]

    14. [SINONIMOS]

    15. [DADOS]

    16. [EVOLUCAO2]

    17. [JOBS]

    18. [TEMPLATES]

    19. [OPCOES_MENU]

    20. [OPCOES_MENU_SAFE]

    21. [TEMPLATES_SAFE]

  5. Cada bloco listado acima por padrão tem duas constantes: ORDEM e NUMFILES

  6. 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
  7. Constante NUMFILES: Essa constante define quantos "Scripts Customizados" a ferramenta deve compilar.

  8. 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].

  9. As constantes NUMFILES de cada bloco [Tipo Objeto] influenciam diretamente na constante FILE. 

  10. 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



  1. Execute como ADMINISTRADOR o arquivo CSIGeraInstallBD.exe, 
  2. Clique em SIM na tela de Controle de Conta de Usuário.



  3. Selecione o Repositório.
  4. Selecione qual o "Tipo do Objeto" vai ser compilado em "Scripts Finais" (você tem a liberdade de criar todos os "Scripts Finais" ou separadamente).
  5. Clique no Botão Gera Install os "Scripts Finais" estarão no diretório designado pela Constante  "PathDestino".



Anexos



AnexoDescrição

Ferramenta Gera_Install e Storex Custom para Download