StreamServe Project Guide and Framework Versão 1.4 / Maio-2013

Transcription

1 StreamServe Project Guide and Framework Versão 1.4 / Maio-2013 PAF011

2 Version control V 1.1 Revisão do documento Rui Miguel (DSI/DIS) V 1.2 Alteração da forma de obtenção do PIARQT Rui Ventura (DSI/DIS) V 1.3 Inclusão do PIARQT651 e PIGENT Rui Miguel (DSI/DIS) V1.4 Alteração da denominação do PIGENT Rui Ventura (DSI/DIS) Direitos Autorais Documento inédito com todos os direitos reservados. A inscrição COPYRIGHT 2011 Galp Energia, SA foi atribuída a este documento para, em caso de publicação acidental, proteger os direitos da Galp Energia SA. Nenhuma parte deste documento pode ser reproduzida sob qualquer forma, inclusive fotocópia ou transmissão electrónica para qualquer computador, sem o prévio consentimento escrito da Galp Energia SA. Confidencialidade As informações contidas neste documento são confidenciais e da propriedade exclusiva da Galp Energia SA, não podendo ser utilizadas, divulgadas, ou cedidas a terceiras partes, sem o prévio consentimento escrito da Galp Energia SA. DSI Arquitetura Aplicacional COPYRIGHT 2011 Galp Energia, SA 2 de 10

3 Index 1 INTRODUCTION OBJECTIVES OF THE DOCUMENTATION DOCUMENTATION DESCRIPTION...4 TYPE OF PROJECTS...4 DOCUMENTATION DESCRIPTION...4 DSI Arquitetura Aplicacional COPYRIGHT 2011 Galp Energia, SA 3 de 10

4 1 Introduction The purpose of this document is to introduce the StreamServe projects documentation needed for the right project management and Galp supervision. 2 Objectives of the documentation The project documentation must help the following needs: To define the Galp project specifications To analyze how to perform the project To manage the StreamServe project live cycle To list the StreamServe objects that can be reuse in next StreamServe projects 3 Documentation description Type of projects Regarding the Galp EDP StreamServe platform, there are two StreamServe projects types: Framework projects Documents projects Documentation Description The following paragraphs contain the framework documents, support s documents and the project documents to be produced. Framework Documents The document PIGEND601 StreamServe Common Functionalities, present the common functionalities associated to StreamServe. This doesn t mean that all of them are available at Galp. To identify these situations, each functionality is identified by one of these acronyms: IF: Implemented functionality. It is an available StreamServe functionality already implemented in the Galp Platform or scheduled to be implemented. (AV): Available. It is StreamServe functionality available in the StreamServe licenses purchased by Galp. DSI Arquitetura Aplicacional COPYRIGHT 2011 Galp Energia, SA 4 de 10

5 NP: Not purchased. Is a StreamServe functionality but it is not available in the StreamServe licenses purchased by Galp. TBT: To be tested. Is a standard StreamServe functionality but it must be checked if it is enough or correct for the expected enhancements. PTBC: Pending to be confirmed. It is StreamServe functionality, but it s pending to confirm if it is purchased by Galp. The document PIGEND602 Stream Server - Best practices and methods presents the best practices to be followed in Galp Energia projects. It is mandatory for the projects to comply with the rules set. If any doubt arises it is strongly advised to contact the Architecture team clear the issue. Support Documents To help in gathering the information to define the scope of a Stream Server, it is available the PIGEND603 RFP Information Gathering. This document should be used by the project manager when defining the scope of the Stream Server component. Another document that can be very useful during the Detailed Design phase is PIGEND604 Data Collection Procedure Sample, which can be used as a reference to the information needed in order to do the detailed design. The information gathered on this process should be included in the following documentation: PIGENT005 Inventário de Requisitos PIGENT011 Definição Desenho Funcional da Solução PIGENT640 Desenho Documento e Definições de Publicação PIGENT612 Technical Design Project Documentation The documentation that a project has to deliver in each phase of the project is presented in the following table: DSI Arquitetura Aplicacional COPYRIGHT 2011 Galp Energia, SA 5 de 10

6 Phase Document Conceptual Definition Detailed Design Implementation Test & Acceptance To Exploration Exploration PIARQT011 Checklist Projecto C A A A PIGENT004 Análise de Gap's C A A PIGENT005 Requisitos Técnicos C/A A A A PIGENT611 Desenho Técnico Alto Nível C A A A PIGENT640 Desenho Documento e Definições de Publicação C A A PIGENT612 Technical Design C A A PIGENT619 Service Specification C A PIGENT613 Deployment C A A PIGENT622 Checklist Deploy C A A PIGENT615 Inventário de Erros_Avisos_Monitorização A A A PIGENT016 Mapeamento de dados - Projecto C A PIQAST001 Plano de abordagem ao teste C A A A PIQAST003 Plano de testes C A A A PIARQT012 Métricas de Projecto C A A A PIARQT651 Métricas da Plataforma C A A A Change Order HP Passagem a Produção (15 dias antes) C Exploration Manual C A A A C - Create; A - Update; Arq - Architecture. DSI Arquitetura Aplicacional COPYRIGHT 2011 Galp Energia, SA 6 de 10

7 PIARQT011 Checklist de Projecto This document has as objectives to: Identify the objects to be used by the project Allow the identification of possible conflicts between projects Validate de object s names Control of the objects that the maintenance team has to give access Control of the objects that the project has permission to ask for environment promotion Control the approval status of the project documentation Control the project regarding the environment promotion PIGENT004 Análise de Gap's This document is used to do a Gap analysis between the actual status of the Aplicacional system and the requirements identified. This document only needs to be created when we have a complex project that might use a significant group of capabilities of the system, and in which we are not sure if they cover the actual requirements or not. PIGENT005 Inventário de Requisitos This document must be used to define the project\client requirements (functional, technical, security, others). PIGENT611 Desenho Técnico Alto Nível This document must be used to give a high level Functional/Technical overview of the solution: Main integration flows on an end-to-end basis Source and destination systems Main transformations and operations done Main objects used to accomplish the tasks PIGENT640 Desenho Documento e Definições de Publicação This document is used to define all the output that StreamServe must produce: Document and data Layout s Data and rules to be applied to present the data The project must be aware of the Marketing guidelines and use the global resources in StreamServe or propose objects to be included in the global resources. DSI Arquitetura Aplicacional COPYRIGHT 2011 Galp Energia, SA 7 de 10

8 PIGENT612 Technical Design This document must describe in detail the implementation done. This document must include: For Framework projects: Process The main process will be Batch, Online, Preview, Specific process (to be defined) Sub process The main sub process will be: Archiving, Retention (Retenção), Electronic invoicing (Facturação Electronica), Massive printing, Routing, Specific process (To Be Define) Integration Tracking Errors messages list Gap analysis DB - SQL list For Document Projects Document design (it could be the same information of Requirement documents) Incoming data o Field description o Document - Data match Document dynamic description Objects & interfaces list Process Sub process Integration Input Output During the process chain Tracking Errors messages list Gap analysis DB - SQL list PIGENT619 Service Specification This document should be used only for documenting a special/global service that the platform will provide. DSI Arquitetura Aplicacional COPYRIGHT 2011 Galp Energia, SA 8 de 10

9 PIGENT613 Deployment This document should have all the information necessary for de maintenance team to do the deployment of the capabilities developed by the project. PIGENT622 Checklist Deploy This document should be a resume of the task to be performed by the maintenance team during the deployment of the capabilities. It should identify the dependencies and if necessary the time intervals expects to finish the task. PIGENT615 Inventário de Erros_Avisos_Monitorização This document must identify the possible errors that can occur, the actions needed to be done to recover from the error and the persons that should be notified. PIGENT016 Mapeamento de dados Projecto This document must be used to map the data between the different Aplicacional systems and all the rules and transformations associated. PIQAST001 Plano de abordagem ao teste This document is used to explain the test strategy in complex environments or when is it critical to identify in great detail the steps needed to be done for the test preparation. PIQAST003 Plano de testes This document must be used to identify the entire test that need to be done do the system (functional, technical, acceptance and load/performance testing). PIARQT012 Métricas de Projecto This document has the objective to give visibility of the tests executed by the project. Mainly: Where all the objects tested; How many executions where done Number and types of errors Execution times This document is obtained by Architecture after the project fills the sheet in the Integração-Métricas (PIARQT012) available in PIARQT011 Checklist de Projeto. PIARQT651 Métricas da Plataforma This document has the objective to give visibility of the tests executed by the project Maily at what DSI Arquitetura Aplicacional COPYRIGHT 2011 Galp Energia, SA 9 de 10

10 where the expected values in terms of performance and the results obtained Change Order HP Passagem a Produção (15 dias antes) This document must be created when the project wants to go to the Consolidated Quality environment or to the production environment. Exploration Manual This document must identify all the task and actions that the maintenance team must do in a: Regular basis; When exceptions occur. DSI Arquitetura Aplicacional COPYRIGHT 2011 Galp Energia, SA 10 de 10