Transcription
Configuration Management PlanCONFIGURATION MANAGEMENTPLANVersion 2-84-PDocument Control Number 1000-000002009-01-30Consortium for Ocean Leadership1201 New York Ave NW, 4th Floor, Washington DC 20005www.OceanLeadership.orgin Cooperation withUniversity of California, San DiegoUniversity of WashingtonWoods Hole Oceanographic InstitutionOregon State UniversityScripps Institution of Oceanography
Configuration Management PlanDocument Control SheetVersion2-84-PDescriptionPublic VersionNote: This document has been edited to remove information that is considered confidentialand/or sensitive to ongoing or future financial negotiations for OOI procurements. Informationremoved has been replaced by the insertion of “[redacted]”.Ver 2-84-PCMPi
Configuration Management PlanTable of Contents:Document Control Sheet .i1 Configuration Management System Structure . 11.1 Purpose . 11.2 Scope. 11.3 Configuration Process . 11.3.1Drawing Standard . 11.3.2Software Versioning and Configuration Process . 11.3.3Implementing Organization Documentation Assurance Process . 11.3.4Implementing Organization Configuration Management Process . 11.4 Responsibility & Authority. 21.5 Configuration Controlled Documents . 21.6 File Formats and Applications . 31.7 File Naming Conventions (Non-Controlled). 41.7.1Terms and Definitions . 41.7.2Conventions . 41.7.3Acronyms . 41.8 File Numbering Conventions (Controlled) . 51.8.1Number Series . 51.8.2Format of Prefix Number . 61.8.3Control Assignment Validation Criteria . 61.8.4Controlled Files Outside of the DMS . 61.9 Other Naming Conventions . 61.9.1Observatory - Instrument Name . 71.10Technical Data Baselines. 92 Document and Information Types . 102.1 Hardware and Software Documentation . 102.2 Document (Drawing) List . 102.3 Procurement Documentation. 102.4 Source Control Document / Vendor Item Drawing . 112.5 Specifications. 112.6 Hardware Parts Lists and Bills of Material. 112.7 Hardware Assembly Drawings . 112.8 Hardware Assembly Procedures . 112.9 Hardware Configuration Database . 112.10Software Configuration Database . 122.11Program Management Support Information. 122.11.1 Program/Project Organization . 132.11.2 Work Breakdown Structure. 132.11.3 Schedules and Activities . 133 Document Management . 143.1 Document Style and Format. 143.2 Document Change Control . 143.3 Change Request Process. 143.4 Document Terms / Information Fields . 143.4.1Controlled Document . 143.4.2Controlled Document Copy. 143.4.3Draft (preliminary) Documents. 143.4.4Candidate Draft (review ready preliminary) Documents. 153.4.5Released Documents. 153.4.6Public Documents . 153.4.7Approval. 153.4.8Author . 153.4.9Release Date . 153.4.10 Version Number . 153.4.11 Version Date . 15Ver 2-84-PCMPii
Configuration Management Plan3.5 Document Management Application, Alfresco . 163.5.1General Overview . 163.5.2OOI Configuration . 163.5.3Attributes in Microsoft Excel and Word Documents . 194 Collaboration Applications. 204.1 Overview. 204.2 Confluence. 204.2.1OOI Configuration . 204.3 JIRA . 214.3.1OOI Configuration . 224.4 Subversion. 234.4.1OOI Configuration . 234.5 DOORS. 264.5.1OOI Configuration . 265 Design Reviews. 295.1 Preliminary Design Review (External). 295.2 Final Design Review (External) . 305.3 Internal Final Design Review (ifdr) (Technical / Engineering) . 325.3.1ifdr Overview . 325.3.2Conducting an Internal Final Design Review. 325.3.3Internal Final Design Review Criteria . 335.3.4Design Verification . 346 Configuration Control Structure. 356.1 Baselines . 356.2 Engineering Change Classes . 356.2.1Class I Changes. 356.2.2Class II Changes. 366.2.3Deviations . 366.2.4Engineering Change Content . 366.3 IO Change Control Board . 376.4 System Level Change Control Board . 376.5 OOI Change Control Board . 386.6 NSF Program Manager Review. 397 Configuration Change Process . 407.1 Requests for Engineering Changes . 407.1.1Assessing the Impact of Requested Changes. 407.1.2Change Control Documentation . 407.1.3Funding for Changes: . 407.2 Change Control Board Operation. 417.2.1Records of Meetings . 417.2.2Timing of Meetings. 417.3 Change Control Board Authority . 417.3.1IO CCB. 417.3.2System Level Change Control Board . 427.3.3OOI Change Control Board . 427.4 Review Authority. 427.5 Consensus and Resolution. 42Appendix A-1 Engineering Change Request Form . AAppendix A-2 OOI Change Control Process Table . AAttachment B-1, OOI Program Terms and Definitions . BVer 2-84-PCMPiii
Configuration Management Plan11.1Configuration Management System StructurePurposeThe Configuration Management Plan (CMP) establishes the activities, responsibilities, processes, andmethods used to document and maintain the design of the Ocean Observatories Initiative (OOI) programand to manage changes to the design and scope of the system.1.2ScopeThe CMP is applicable to all OOI system and subsystem hardware and software technical data, designsand software code and hardware developed or delivered as part of the OOI program. The OOI"program" includes all of the National Science Foundation (NSF) funded resources and materials underthe RR&A and MREFC agreements with the Consortium for Ocean Leadership (Ocean Leadership) andsub-awardees. The OOI Program includes "projects" which are groups of tasks undertaken by a specificsub-awardee or resources within the larger program.The CMP defines the roles, responsibilities, and authorities of the OOI team members in theconfiguration management of the OOI planning, requirements flow, design, development, andimplementation phases.1.3Configuration ProcessThe Implementing Organization (IO) shall have the following standards and processes in place andfollow the standards and processes in the performance of the contract:a) Drawing Standard / Software Coding Standardsb) Software Versioning and Configuration Processc) IO Documentation Assurance Processd) IO Configuration Management Process1.3.1Drawing StandardThe IO has the option of utilizing its own drawing standard if it is similar to or exceeds the AmericanSociety of Mechanical Engineers (ASME) Y14.100 (Engineering Drawing Practices) requirements,otherwise ASME Y14.100 shall be used as the drawing standard. The standard must provideengineering definition to assure the functional interchangeability of parts when procured from original oralternate sources.1.3.2Software Versioning and Configuration Process[Reserved]1.3.3Implementing Organization Documentation Assurance ProcessThe IO shall have a process in place that assures that the Technical Data Package delivered hasundergone a thorough and structured creation, check, and approval cycle.1.3.4Implementing Organization Configuration Management ProcessThe IO shall have a Configuration Management Process in place that describes the IO’s configurationcontrol processes. Each IO shall assign the duties of a Configuration Manager (administrative) to one ofthe members of the IO project office. This process shall also include a structured Engineering ChangeBoard (ECB) process compliant with OOI policies and procedures.Ver 2-84-PCMPPage 1 of 43
Configuration Management Plan1.4Responsibility & AuthorityThe responsibilities and authority of the members of the OOI project teams are defined by thecooperative agreement between the National Science Foundation (NSF) and the Consortium for OceanLeadership (Ocean Leadership), and the subaward contracts between Ocean Leadership and the IOs.The roles of the members are outlined below.NSF Program Director: The NSF Program Director is the program sponsor and has the sole authority torevise any program baselines. Program Baselines are defined as: the milestone point-in-time scope and"state" of the related programmatic metrics. Specifically, at the NSF level, these are the programtechnical scope, cost and schedule.Program Director for Ocean Observing Activities: The Program Director for Ocean Observing Activities atOcean Leadership is the principal investigator and program manager. He/she has the authority andresponsibility to carry out the policies and activities described herein, and may delegate such authorityas required.Director of Engineering: The OOI Director of Engineering has primary responsibility for all system levelissues. The Director of Engineering will work with the OOI System Engineer and the subsystemContracting Officer’s Technical Representatives (COTRs) to implement the configuration managementprocess as described herein across the collaboration to ensure that requirements and interfaces are fullydefined, documented and maintained.The approval of the Director of Engineering is required on all documents and decisions that have thepotential to impact the ability of the delivered system/instrument to meet the allocated sciencerequirements.Configuration Manager: The Configuration Manager will maintain the document list, assure changes arecompleted correctly, and supervise distribution (posting) of new revisions and the recall of obsoletedocuments. The Configuration Manager reports to the Director of Engineering. The OOI Program Officewill assign a Configuration Manager for the OOI, and each IO shall assign the duties of configurationmanagement to a member of the IO project management team.1.5Configuration Controlled DocumentsDocuments and records will be maintained as described in this plan, including the following keyproducts: Science Prospectus and Traceability MatrixScience RequirementsEngineering Requirements DocumentsInterface Agreement/Control DocumentsDOORS Requirements DatabaseEngineering Design Documents (FND, drawings, specifications)Technical Data Packages (TDP)Network Design (documents and drawings)Program Plans and Policies (e.g., EVMS Guide, SEMP, Risk Management Plan, CEP)Project Execution Plan (PEP)Work Breakdown Structure (WBS) and related support documentsIntegrated Master Schedule (IMS)Cost Book DatabaseProgram Management Baseline Documents (including test plans)Logistic Support DocumentsA Technical Data Package (TDP) is a technical description of an item adequate for supporting anacquisition strategy, development, manufacturing development, production, engineering, and logisticsthroughout the item's lifecycle. The technical description defines the required design configuration andprocedures required to ensure adequacy of item performance.Ver 2-84-PCMPPage 2 of 43
Configuration Management PlanA TDP is comprised of a variety of data that will define the item/system. The categories of data in a TDPinclude, but are not limited to: Product Definition DataEngineering DrawingsAssociated ListsSpecificationsStandardsPerformance RequirementsQuality Assurance ProvisionsReliability DataPackaging DetailsModeling Data"Product definition data" denotes the totality of data elements required to completely define a product.Product definition data includes geometry, topology, relationships, tolerances, attributes, and featuresnecessary to completely define a component part or an assembly of parts for the purpose of design,analysis, manufacture, test, inspection and maintenance.1.6File Formats and ApplicationsThe following file formats shall be used to create and exchange information between IOs and the OOIProgram Office and in preparation of any technical data package.File TypeDatabaseDocument AuthoringDocument DistributionGeneral GraphicsNetwork or Diagram GraphicsScheduling and Project ManagementTechnical Data DistributionFile Format (Application)Access 2003Word 2003 or compatiblePortable Document Format (PDF)CAD interchange with 2d AutoCAD version12 (aka 2008) or AutoCAD LT for 2d.Note: 3D models not necessary forexchange.Note: vector formVisio / Omni GraffleProject 2003ExcelCollaborative ApplicationConfluenceAlfrescoJIRASubversionDOORS and Software Architect (CI)DescriptionWeb collaborative environment / WIKIConfiguration / File ManagementAction Item / Issue TrackingSoftware Code CMRequirements Tracking / TracingEngineering DrawingsNote: See Collaborative Applications Section 4 for details.Ver 2-84-PCMPPage 3 of 43
Configuration Management Plan1.7File Naming Conventions (Non-Controlled)The following naming convention shall be used to exchange information between IOs and the OOIProgram Office and in preparation of any technical data package of non-controlled documents/drawings.This naming convention is also used for documents prior to their submittal to the DMS or prior to theissuance of a control number.File Name: Short Descriptive Name, System Level, YYYY-MM-DD ver #-##.extShort Descriptive Name: relative to the subject or name of the documentSystem Level: identifying the scope of the document, from a sensor, platform, location,observatory, or top level, (e.g.: OOI, Irminger, RSN)Date: in four digit year, dash, two digit month, dash, two digit day, representing the completiondate or release date of the document, incremented as changes are madeVersion: "ver" indicating the major release number and the minor working level, number dashnumber. A required element if a released version of a configuration controlled document. Usedfor version tracking in non-configuration controlled documents. (e.g.: ver 2-05) Use a leadingzero for "dash" 1 through "dash" 9 (e.g. -01, -02, -09)Note: Underscores are used as separators, no spaces permitted in file names. Dashes are to be usedonly for the date string and version number string. For example: 1.7.1CMP OOI 2008-01-21 ver 2-05.doc [Configuration Management Plan]Preliminary Design Document CI 2007-07-24.docTerms and DefinitionsThe OOI Program terms and definitions list is maintained by the OOI SE and is part of the CMP byattachment. "Attachment B-1, OOI Program Terms and Definitions" will be updated throughout thelifecycle of the program.1.7.2ConventionsThe OOI Program and IO Projects will develop multiple naming and alpha-numeric identification andtracking conventions. The conventions will be maintained by the IO SE and OOI SE and are part of theCMP by attachment. "Attachment B-2, OOI Program Naming and Identification Conventions" will beupdated throughout the lifecycle of the program.1.7.3AcronymsThe following acronyms are acceptable for file naming use within OOI.TitleBasis of Estimate (by WBS Element)Cost Estimating PlanConfiguration Management PlanEarned Value Management System PlanEnvironmental, Health and Safety PlanEducation and Public EngagementFinal Network DesignIntegrated Master ScheduleOperations and Maintenance PlanProject Execution PlanQuality Assurance and Quality Control PlanSystems Engineering Management PlanWork Breakdown StructureVer 2-84-PCMPAcronymBOECEPCMPEVMS PlanEHSPEPEFNDIMSOM PlanPEPQA QC PlanSEMPWBSPage 4 of 43
Configuration Management Plan1.8File Numbering Conventions (Controlled)All controlled and release level documents shall have an OOI / IO document series number assignedand added as a prefix to the document file name. The OOI and IO level configuration managers shallassign and track the requests and issuance of the document numbers. The OOI System Engineer hasprimary responsibility for all system level configuration issues. The OOI System Engineer shall disperseand assign file numbers and series of numbers from the system level. The IOs shall implement asystem-level umbrella file number/naming convention to append to the OOI / IO series, specific to therequirements of the IO configuration management process for controlled documents and drawings. TheIO Configuration Manager/SE shall assign from within the series identified for each IO.1.8.1Number SeriesThe convention shall follow the integrated Work Breakdown Structure (WBS), with series numberscorresponding to the second level of the WBS.Series Number10002000300040005000600070008000OOI System Level1000 - 10991100 - 11991200 - 12991500 - 15991600 - 16991700 - 17992nd Level WBS nn 2, 3, 4, or 7IO System / Subsystemn000 - n099n100 - n199n200 - n299n300 - n499n500 - n599n600 - n699n700 - n799n800 - n999Note:Example:4800 - 4999Ver 2-84-PAssignmentOOI/System LevelCyberinfrastructureCoastal GlobalRegionalOperations and Maintenance(reserved)Education and Public Engagement(reserved)DocumentsOOI Programmatic DocumentsOOI Systems Engineering DocumentsOOI Installation DocumentsDrawingsOOI Programmatic DrawingsOOI Systems Engineering DrawingsOOI Installation DrawingsDocumentsIO Programmatic DocumentsIO Systems Engineering DocumentsIO Installation DocumentsIO Subsystem DocumentsDrawingsIO Programmatic DrawingsIO Systems Engineering DrawingsIO Installation DrawingsIO Subsystem DrawingsCI 2, CG 3, RSN 4, EPE 7RSN Subsystem DrawingsCMPPage 5 of 43
Configuration Management Plan1.8.2Format of Prefix NumberIO Seqan d ue nc ingSe parat ionFo rmat" sepa ra tor"Be nt TRa ng y peeDoc umWBS2 ndDe s ig Le ve ln at ionThe Series Number prefix shall follow the following format (# # # # - # # # # # ):NumericNumericSymbolNumeric### #-## ## #Number ofCharacters1315MandatoryCharacterassignedleading zeros"-"dashleading zerosChar TypeIO Sequence Num, a 5 digit numericcode that denotes specific variants of IOspecific items, can be used as asequenc e (leading zeros).IO Range Num, a 3 digit numeric code that denotes the IO specificitem (leading zeros).WBS 2nd Level Designation, a 1 numeric c ode that denotes the OOI 2nd LevelWBS System/Sub-System of the item.Examples:1.8.31001-00000 PEP.doc1101-00000 FND.docControl Assignment Validation CriteriaThe Document Management System (DMS) "Alfresco" assigns a sequential "revision" number to thedocument when it is loaded and each time the document is changed. This "revision" number is notrecorded in or on the file or document.The CM must ensure that the "Version" number assigned and tracked for OOI controlled files is includedon the cover and in the document control sheet of each file, prior to assigning a control number. The"Version" number must be recorded in the DMS in the notes section along with the date of the "Version"issuance at each upload or modification to the file in the system.1.8.4Controlled Files Outside of the DMSChecking-out, downloading, exporting or off-line editing of a controlled document outside of the DMSrequires that the file name be appended with the versioning convention described in Section 1.7. TheOOI Version Number should be appended to the file name. In all cases the DMS document is thedocument of record, and the Configuration Manager will manage all updates from external sources.1.9Other Naming ConventionsThe OOI Program and IO Projects will develop multiple naming and alpha-numeric identification andtracking conventions. The conventions will be maintained by the IO SE and OOI SE and are part of theCMP.Ver 2-84-PCMPPage 6 of 43
Configuration Management Plan1.9.1Observatory - Instrument NameThe Configuration Item naming convention below is used to uniquely identify components in the systemat the instrument level. This convention will be used to identify items such as Control Centers, ShoreStations, Buoys, Nodes, Cables, Instruments and Sensors in a consistent manor across alldocumentation and databases. Accurate and consistent identification of components is required foreffective fault management, auto-discovery, performance reporting, sensor data storage, etc. Theidentification of the instrument and accurate correlation between and an item identifier and all databasesthat contain supporting information is supported by the Instrument ID naming convention.An OOI Node is defined as an entity that aggregates ports and/or distributes power, time, andcommunications. An OOI Instrument is defined as a collection of transducers, data samplers, dataloggers and transducer controller, with a known internal structure/geometry.Instrument ID Field(total characters: 27)AlphaAAChar TypeNumber 2312151"-"dash"-"dashIn st rumSe qu en tenN um c ebe rIns trum entSe(dis c riesrimina to rIns trumenCla s tsCFo rmat"se par ator"N umP ortF or mat" se pa ra tor" BNo deNodeSS e qu itee nceTy peBFo rmat" separ a tor"CodeS iteNumeric##" 0# "leading zerofor singledigitMandatoryCharacter1.9.1.2SiteNu mbe rOs erv a tory /Array)1.9.1.1Numeric###3"00# "leading zerosfor singledigit"-"dashExample Instrument 307-TEMPWA301RSN, site number 2, Blanco, Low Voltage Node number 3, port number 7, water temperature instrument, series A1.9.1.3Field Names and DescriptionsObservatory / Array2 character alpha code that denotes the OOI Sub-System of the item.Site Num2 character numeric code that denotes the Site Number of the item (leadingze
Configuration Management Plan CONFIGURATION MANAGEMENT PLAN Version 2-84-P Document Control Number 1000-00000 2009-01-30 Consortium for Ocean Leadership 1201 New York Ave NW, 4th Floor, Washington DC 20005 www.OceanLeadership.org in Cooperation with University of California, San Diego University of Washington Woods Hole Oceanographic Institution
