SGE – Sistema de Gerenciamento de Especificação Data: 28/09/2011 Criado Por Flavio Amoedo Peres Neto Controle e Gerenciamento de Documentações de programas Versão 01.00 (Projeto Interno TI) Antes de imprimir pense em sua responsabilidade e compromisso com o MEIO AMBIENTE! Think about your responsibility and commitment with the Environment before printing! Página 1 – Futuro - Atenção SGE – Sistema de Gerenciamento de Especificação Data: 28/09/2011 Criado Por Flavio Amoedo Peres Neto Sumário 1. 2. Introdução ............................................................................................................................. 3 1.1. Escopo ........................................................................................................................... 3 1.2. Diagrama Geral.............................................................................................................. 3 1.3. Atores ............................................................................................................................ 3 1.4. Premissas....................................................................................................................... 3 1.5. Esboço do sistema ......................................................................................................... 3 1.6. Dependências ................................................................................................................ 3 Especificação Funcional......................................................................................................... 4 2.1. Modelagem dos Dados.................................................................................................. 4 2.2. RFC – Busca de dados .................................................................................................... 4 2.3. Programa Para Documentação (Especificação) ............................................................ 5 2.1.3. Criação ................................................................................................................... 5 2.1.4. Modificação .......................................................................................................... 6 2.1.5. Exibir..................................................................................................................... 6 2.1.6. Verificação de Autorização.................................................................................... 6 2.4. WorkFlow ...................................................................................................................... 6 2.4.1. Estrutura organizacional ....................................................................................... 6 2.4.2. Método de aprovação ........................................................................................... 6 2.5. Criação do Documento (WORD).................................................................................... 7 3. Aprovação ............................................................................................................................. 7 4. Modificações ......................................................................................................................... 7 Página 2 – Futuro - Atenção SGE – Sistema de Gerenciamento de Especificação Data: 28/09/2011 Criado Por Flavio Amoedo Peres Neto 1. Introdução Transação para controle e gerenciamento para Facilitar Documentações de Programas em Desenvolvimento, Este Programa tem como objetivo Buscar Programas ainda não cadastrados no SOLUTION MANAGER e Efetuar a Devida Solicitação de Especificação. Outra Função Futura será aprovação de Especificações pelo superior do Criador do Documento. Neste Desenvolvimento também é esperado um gerenciamento de CR para facilitar quando formos transferir os devidos programas para o Ambiente de QA1 e QAP (Qualidade) e PRD (Produção). 1.1.Escopo Todo Programa Existente em DEV (Desenvolvimento) e que for Solicitado para iniciar a especificação. Com o Objetivo de facilitar a Documentação dos programas Criados pela CBC. 1.2.Diagrama Geral 1.3.Atores Usuários Criadores de especificações Técnicas 1.4.Premissas Programa Deve Existir em DEV 1.5.Esboço do sistema Função principal RFC Entrada – Nome do Programa Saída – Descrição, Código Fonte, Tipo de Programa. 1.6.Dependências Página 3 – Futuro - Atenção SGE – Sistema de Gerenciamento de Especificação Data: 28/09/2011 Criado Por Flavio Amoedo Peres Neto 2. Especificação Funcional Valores Detalhes Impacto para o negócio Alta Média Baixa Complexidade do Desenvolvimento M.Alta Alta Média Modulo de Referencia Prioridade Baixa BC – Basic Components Alta Média Baixa 2.1.Modelagem dos Dados Logica para busca dos dados e como trata-los – Descrição do Programa e Dados Referentes ao código Fonte. Para Melhor tratarmos os dados iremos dividir em função, cada logica para busca dos dados no código fonte, Por exemplo, teremos uma função para busca tabelas no código, e Outra para busca AUTHORITY-CHECK. 2.2.RFC – Busca de dados Primeiro Passo é Criarmos a RFC que Será Chamada pelo ambiente Solution Manager (SOL), Esta Função é destinada a Buscar os dados referentes ao Programa ABAP do Ambiente Desenvolvimento (DEV). Sugestão de nome para a Função ZFBC_GET_DATA_PROGABAP_RFC. A Função Deve Ser Criada para entrar dos Seguintes Dados: Campo Tipo CPROG TYPE SY-REPID E Como Saída: ZSTRUC1 Campo Tabela Campo2 Tipo NAME REPOSRC PROGNAME PROGNAME TEXT TRDIRT TEXT REPTI CNAM REPOSRC CNAM CNAM CDAT REPOSRC CDAT RDIR_CDATE UNAM REPOSRC UNAM UNAM UDAT REPOSRC UDAT RDIR_UDATE 2.2.1.1. E código fonte em tabela com campo STRING Após Efetuar Esta Busca no próprio Ambiente SOL Criar uma Função para Busca de Dados relevantes no código Fonte, Onde Todas estas Funções terão os mesmos dados de Entrada e Saída. Entrada: Nome do Programa. Saída: Tabela com apenas um campo texto. Sugestão de nomes: ZFBC_GET_&&&&&&&&&&&&&&&&_CODE. Página 4 – Futuro - Atenção SGE – Sistema de Gerenciamento de Especificação Data: 28/09/2011 Criado Por Flavio Amoedo Peres Neto Exemplo: ZFBC_GET_TABLES_CODE, ZFBC_GET_AUTHORYCHECK_CODE, Etc. OBS. Todas as Funções serão chamadas Dinamicamente, Todas Elas no caso terão de ser cadastras em uma tabela de configuração, Criada especificamente para este Desenvolvimento, devidamente todas elas teram os mesmo modelo de entrar e saída de dados (Sugestão de Nome para tabela de configuração: ZTBBC_FNC_SGE) Para cada Tabela Cadastrada na Tabela ZTBBC_FNC_SGE – passa como entrada o código Fonte do programa e Retornar uma Tabela de Texto com apenas um Campo. 2.3.Programa Para Documentação (Especificação) Tela inicial: Segunda Tela : 2.1.3.Criação Programa que Efetuara a Documentação, Programa Utilizara a RFC anterior para obter os dados iniciais. Página 5 – Futuro - Atenção SGE – Sistema de Gerenciamento de Especificação Data: 28/09/2011 Criado Por Flavio Amoedo Peres Neto Devera ter na tela Inicial a Possibilidade de Entrar com o nome do programa (Programa que deseja documentar), que será passado ha RFC para busca dos dados referentes ao programa, caso o programa Não esteja ativo ou não exista, emitir a seguinte mensagem (Programa não existe na Forma ativa). Para Melhor controlarmos os textos (o mesmo não será gravado em tabela Z, para guardar esse tipo de informação) será utilizada a Função SAVE_TEXT (Usar Transação SO10 para Visualizar Textos). O programa também deve ter a possibilidade de convertermos isso para WORD utilizando Função do OLE2, no qual ainda será decidido o layout do WORD. Caso o Programa Tenha Includes Identificar o mesmo e Efetuar a Verificação para cada include existente no Programa, o u seja, mesmo quando existir include, devemos entrar em cada uma e efetuar a mesma logica. 2.1.4.Modificação Nesta Opção é possível efetuar todos os tipo de alteração igual a Criação, só que no inicio da execução deste método não se pode efetuar a Execução da RFC, apenas será executado esta opção quando for solicitado pelo usuário através de algum botão com confirmação. 2.1.5.Exibir Nesta Opção apenas será apresentado os dados criados no SOL, Não terá nenhuma opção de modificação de nenhum registro da documentação. 2.1.6. Verificação de Autorização Teremos acesso para Criar, Modificar e exibir documentação. 2.4.WorkFlow Para melhor controle das documentações, também será feito um método de aprovação de especificação, assim garantindo a qualidade. 2.4.1. Estrutura organizacional Todas as Especificações ativadas e em solicitação de Aprovação serão passadas ao superior do criador do documento. No caso apenas ABAP’S terão acesso para Criar Especificações, deste modo o aprovador das Especificações será o Responsável pelo mesmo. 2.4.2. Método de aprovação Primeiramente chamaremos um evento, no momento em que o ABAP Ativar sua Documentação, aparecera uma pergunta na tela Enviar solicitação de aprovação de Especificação, se for selecionado a opção (sim) então chamamos o evento. Página 6 – Futuro - Atenção SGE – Sistema de Gerenciamento de Especificação Data: 28/09/2011 Criado Por Flavio Amoedo Peres Neto 2.4.2.1. Aprovado Se por um acaso a especificação for aprovada será modificado o Status de Aprovação da Especificação 2.4.2.2. Recusado Se por um acaso a Especificação for Reprovada será modificado o Status de Aprovação da Especificação para Recusado, e assim Mandaremos um e-mail para o Criador da Especificação demonstrando a causa da Reprovação. 2.5.Criação do Documento (WORD) Todos os Documentos Deverão ser Transformados para o Formato WORD, utilizando métodos de OLE2, assim criando documentos conforme dados retirados do Solution Manager (SOL). 3. Aprovação Apenas será iniciada a Codificação do programa referente ah especificação acima, quando for aprovada por e-mail a solicitação de inicio. 4. Modificações Ultimas Modificações no Documento João – Dia 28/09/2011 1. Para este desenvolvimento vamos criar tudo como BC (Basis Component), e se for preciso criaremos um pacote específico para isto; 2. Em questão ao Workflow não acho viável fazer, pelo menos não por enquanto; 3. Eu senti falta de algum padrão em relação ao módulo funcional que será a EF/desenvolvimento e sua classificação, por exemplo, Módulo MM, Classificação “Desenvolvimento Complexo” e “Alto Impacto para o negócio”. João – Dia 29/09/2011 Na divisão das “ABAS” do programa achei legal o que você desenhou, vamos por enquanto criar as ABAS abaixo: Informações Gerais; Documentação; Requests; Objetos utilizados (Tabelas, Funções, Authority-Check, etc.) Anexos (Vamos discutir posteriormente). Página 7 – Futuro - Atenção