Company Oracle

SYSTEM STANDARDS

IT PROJECT DEVELOPMENT TO RELEASE PROCESSES
Author: Creation Date: Version: Last Updated: Brendan Furey 19 June 2012 1.1 20 June 2012

100972327.doc

.

Page 1 of 10

Table of Contents

Document Control..............................................................................................3 Change Record.............................................................................................3 Introduction.......................................................................................................4 Development Process........................................................................................5 Process........................................................................................................5 Definitions....................................................................................................5 Directory Structures...........................................................................................6 PVCS............................................................................................................6 Releases......................................................................................................6 APP Code.....................................................................................................7 BSP3 Code...................................................................................................7 File Notes...........................................................................................................9 Naming Conventions....................................................................................9 Issues and References.....................................................................................10 Issues.........................................................................................................10 References.................................................................................................10

100972327.doc

Page 2 of 10

Document Control
Change Record
Date 19-Jun-2012 20-Jun-2012 Author BPF BPF Version 1.0 1.1 Change Reference Initial Title and references

100972327.doc

Page 3 of 10

Introduction
This document describes standards for development and release to production suitable for small teams involved in development and maintenance of a number of database systems. It was written for a team working on four related systems. One of the systems was based around an Oracle CRM system with customisations, for a customer loyalty program. Another was a parallel completely bespoke Oracle system aimed at a different market sector, and the other two comprised a data warehouse of transactions and reference data and a staging database used for interfacing. Oracle Applications has extensive document templates from its AIM (Application Implementation Methodology) approach and some of the documents form part of our standards. Also, Oracle Applications has a standard directory structure for code and this is followed here for the example system of that type, while the other, bespoke, systems have their own structure based on the same general idea.

100972327.doc

.

Page 4 of 10

Development Process
Process
The development process is considered to start from the point where requirements are understood, and is described here for development projects within a system (i.e. not for completely new systems, which require additional system design documents), and comprises the following major steps, with associated documents: • Write analysis document (PA010) o This is an optional document that describes the analysis done for a problem, and any outline solution approaches that may be identified. This may be appropriate for more complex problems, or where the analysis has been done, but development of the solution is not imminent; otherwise, analysis material may be included in the design documents. There will always be at least one of the so-called functional or technical designs, with the choice depending on the nature of the development. Functional documents will generally also contain technical material, and vice versa. In some cases both may be deemed necessary. The coding will be done on the development system, and its installation documented in the MD120, based on the template document, MD120 - Template.doc, that will include a list of all deliverable files. Where a development involves more than one system, there will be separate MD120s for each system. A release directory structure will be set up in development, as described below, with a .tar archive. A release may include more than one system. Testing will be implemented initially on the development system, and documented by the mandatory test plan document, based on the template document, TE040 - Template.doc. This will be initially just the plan, but on execution will be extended with results, test data, SQL used etc. The document may then be the basis for testing in UAT and production, and extended as necessary.

Write design document (MD050, MD070) o

Implement design on development system (MD120) o

o •

Write and execute test plan (TE040) o

Definitions
• • • • • APP – An Oracle Applications-based System BSP1 – Bespoke System 1 BSP2 – Bespoke System 2 BSP3 – Bespoke System 3 PVCS – Version control system (could be any one)

100972327.doc

Page 5 of 10

Directory Structures
PVCS
The PVCS structure is designed to hold both code and documentation, and for convenience splits the different subsystems of the systems at the bottom levels, where applicable, as shown in the table below. For larger, more independent systems than our example, one might prefer to split at the top level. Additional subdirectories will be added as necessary, e.g. for forms, and also for additional subsystems, such as BSP1. Root = M:\Projects\APP Level Level 2 Level 3 Description 4 BSP2 BSP3 DR010 – Drawings Visio diagrams BSP1 APP MD050 – Functional Design Functional design, typically across systems MD070 – Technical Design Technical design, typically across systems BSP3 MD120 – Installation Installation, by system APP PA010 – Problem Analysis Problem analysis, typically across systems Request for Change RFCs BSP2 SD010 – System Design General System design APP System standards, such as release SS010 – System Standards procedure TE040 – Test Plan Testing, typically across systems Alter DDL scripts such as scripts for adding BSP3 columns to tables Alter APP DDL Creation DDL scripts such as table creation BSP3 scripts Create APP FNDLoad FNDLOAD .ldt files (APP only) Releases Release archives (.tar files) BSP3 Shell Installation shell scripts APP BSP3 SQL Installation SQL scripts APP BSP3 Database packages APP BSP3 Executable shell scripts APP BSP3 Executable SQL scripts APP BSP3 Database views APP

Level 1

Documentation

Install

Packages Shell SQL Views

Releases
Each release (indexed i, say) will have a directory rel_i, with a subdirectory for each system within the release..The system subdirectories will be structured according to what is involved in the release, with the table below providing an example. The directory structure will be created manually on the development instance, and put into a Unix archive, rel_i.tar, for recreating on the other instances. The release root directory will include a Read_me.txt that briefly describes the functionality of the release and mentions all related PVCS documents, including MD120s.

100972327.doc

Page 6 of 10

The release on other instances will be accomplished by untarring the archive, copying the source files using a script cp_rel_i.x, that will be in the release root directory, then completing the release by following the instructions in the MD120 documents. Root $ES_PATH/releases/rel_i Level 1 Level 2 bin import APP install sql bin BSP3 install sql File Read_Me.txt cp_rel_i.x Level 3 backup backup bin sql backup backup bin sql backup backup backup Level 4 Description Description of functionality; list of PVCS documents Shell script to copy release files to code directories, and do backups Description Executable shell scripts Executable shell scripts - backups FNDLOAD .ldt files FNDLOAD .ldt files - backups Installation shell scripts Installation SQL scripts Installation SQL scripts - backups Executable SQL scripts Executable SQL scripts - backups Executable shell scripts Executable shell scripts - backups Installation shell scripts Installation SQL scripts Installation SQL scripts - backups Executable SQL scripts Executable SQL scripts - backups

APP Code
The APP code directory structure largely follows the Oracle Applications standard, with a custom root directory, and subdirectories for the different code types, as shown in the table below (to which additional types may be added as need, such as for forms). Additionally, we have created backup directories that will hold the previous versions of code where applicable. Level 1 bin import install sql Level 2 backup backup bin sql backup Root = $XXEFT_TOP Level 3 Description Executable shell scripts Executable shell scripts - backups FNDLOAD .ldt files FNDLOAD .ldt files - backups Installation shell scripts Installation SQL scripts backup Installation SQL scripts - backups Executable SQL scripts Executable SQL scripts - backups

BSP3 Code
The BSP3 code directory structure is similar to that for APP, but with its own root, and no import directory, as that is specific to FNDLOAD, the Oracle Applications utility. As with the other directory structures, this will be extended as necessary. Level 1 bin install sql
100972327.doc

Level 2 backup bin sql

Root = $ES_PATH/code Level 3 Description Executable shell scripts Executable shell scripts - backups Installation shell scripts Installation SQL scripts backup Installation SQL scripts - backups Executable SQL scripts
Page 7 of 10

backup

Executable SQL scripts - backups

100972327.doc

Page 8 of 10

File Notes
Naming Conventions
File Type MD050 – Functional Design MD070 – Technical Design MD120 – Installation PA010 – Problem Analysis TE040 – Test Plan Packages Installation shell scripts Executable shell scripts DDL Alter DDL Create Installation SQL Executable SQL Views View name in mixed case, with acronyms in upper case, extension .sql COM_Pre_Fulfillment_V.sql Naming Convention MD050 – (description).doc MD070 – (description).doc MD120 – (description).doc PA010 – (description).doc TE040 – (description).doc Package name in mixed case, with acronyms in upper case, extension .pks for spec, .pkb for bodies Descriptive name in mixed case, with acronyms in upper case, extension .x Descriptive name in mixed case, with acronyms in upper case, extension .prog Release name (initcapped), system code, then description of operation, extension .ddl Name of main entity in mixed case, with acronyms in upper case, extension .ddl Example MD050 - APP Fulfilment Scheduling.doc MD070 - Company Pre-Fulfilment View.doc MD120 - APP Fulfilment Scheduling.doc TE040 - APP Fulfilment Scheduling.doc Company_BSP2_Processing.pkb XX_UpCP.x

Rel_1_APP_Add_Columns.ddl

100972327.doc

Page 9 of 10

Issues and References
Issues
# 1 Issue Description Note if closed

References
REF REF-1 REF-2 REF-3 REF-4 Document Oracle Applications Extension Installation Template, BP Furey, November 2009 Unit Test Plan Template, BP Furey, November 2009 Oracle Forms Generic UTP, BP Furey, May 2009 Oracle Applications FNDLOAD Unix Scripts, BP Furey, July 2009 Location http://www.scribd.com/doc/21977042/Orac le-Applications-Extension-InstallationTemplate http://www.scribd.com/doc/21977344/UnitTest-Plan-Template http://www.scribd.com/doc/15790663/Orac le-Forms-Generic-UTP http://www.scribd.com/doc/17029415/Orac le-Applications-FNDLOAD-Unix-Scripts

100972327.doc

Page 10 of 10

Sign up to vote on this title
UsefulNot useful